WebAPIの利用(エンタープライズ・プラン対象)

WebAPIを設定する

WebAPIで使えるメソッドとサンプルコードをご紹介します。

インターフェース仕様

以下のURLにPOST形式にて引数をリクエストしてください。
引数が適切な場合、サブセットフォントファイル(※1)、cssファイル、javascriptファイルをzipファイルにまとめ、お返しします。

https://webfont.fontplus.jp/api/

引数一覧

引数項目名桁数必須設定内容
contractor_code契約者コード10半角文字列例) C000000000
web_api_keyWebAPIキー256半角文字列例)W123456789
※発行したAPIキー
contract_number契約番号14半角文字列例) S0010000100-01
text[]リクエスト
文字列
1000マルチバイト
文字列
例) 今日はいい天気
fontname[]書体名100マルチバイト
文字列
例) FOT-Rodin Pro L
font_nickname[]任意の書体名(※1)100マルチバイト
文字列
任意例) fp-font1
css_nickname任意のCSS名(※2)100マルチバイト
文字列
任意例) fontplus→fontplus.css
js_nickname任意のJavaScript名(※3)100マルチバイト
文字列
任意例) fontplus→fontplus.js
typeフォント形式(※4)4半角文字列任意WOFF/EOT/TTF/OTF/SVG

契約者コード、WebAPIキー、契約番号は ログイン後 > エンタープライズ > 契約一覧ページにてご確認ください。
リクエスト文字列、書体名、任意の書体名は配列での引数となります。一度のWebAPIリクエストで複数の書体が取得できます。

※1「任意の書体名」:任意の書体名を指定しない場合、ユニークな文字列となります。任意の書体名を指定した場合、それぞれのサブセットフォントファイルに拡張子が付きます。 また、font-family名も指定したファイル名になりますのでHTML内で指定するfont-family名にご注意ください。ファイルを上書きしたい場合などにご使用いただけます。

※2「任意のCSS名」:任意のCSS名を指定しない場合、SubFontCSS.cssとSubFontCSS_h.cssになります。任意のCSS名を指定した場合、指定したcss名と「_h」が追加されたcssファイルになります。

※3「任意のJavaScript名」:任意のJavaScript名を指定しない場合、SubFontJS.jsになります。任意のJavaScript名を指定した場合、指定したJavaScript名になります。

※4「フォント形式」:フォント形式を指定しない場合、WOFF、OTF、TTF、EOT、SVGの5種類(フォントによっては4種類)でのファイル構成になります。フォント形式を指定した場合、指定した種類のみのファイル構成になります。

サンプルコード

PHP サンプルコード

$text = array('あいうえお今日もいい天気', 'かきくけこ今日もいい天気', 'さしすせそ今日もいい天気', 'たちつてと今日もいい天気');
$fontname = array('FOT-筑紫A丸ゴシック Std L', 'FOT-筑紫明朝 Pr6 M', 'FOT-ロダン ProN DB', 'MatisseProN-UB');
$font_nickname = array('nick1', 'nick2', 'nick3', 'nick4');
$css_nickname = ('fontplus_css');
$js_nickname = ('fontplus_js');

$data = array(
    'contractor_code' => 'C123456789',
    'web_api_key' => 'W123456789',
    'contract_number' => 'S0000001234-99',
    'text' => $text,
    'fontname' => $fontname,
    'font_nickname' => $font_nickname,
    'css_nickname' => $css_nickname,
    'js_nickname' => $js_nickname
);

$url = 'https://webfont.fontplus.jp/api/';

//エンコード
$data = http_build_query($data, "", "&");

//オプション作成
$options = array('http' => array(
    'method' => 'POST',
    'header' => 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8'."\r\n".'Content-length: '.strlen($data),
    'content' => $data
));

// 要求送信/受信
$response = file_get_contents($url, false, stream_context_create($options));


header('Content-Type: application/octet-stream');
header('Content-Disposition: attachment; filename="fontplus.zip"');
echo $response;

エラーコード一覧

引数などに誤りがある場合、以下のいずれかのエラーコードが戻り値になります。 内容についてご確認ください。

エラーコード説明
1001引数が不正です。引数についてご確認をお願いいたします。
1002認証に失敗しました。WebAPIキーと契約者コード、契約番号が一致しません。再度認証をご確認ください。
1003指定のフォントは利用できません。ご利用いただけるフォントに制限がございます。書体名を再度ご確認ください。
1004Webフォントを適用するユニーク(一意)文字数が1,000文字を超えています。
1005予期せぬエラーが発生しました。原因究明のため、記載した値をお問い合わせフォームよりお知らせください。
9999予期せぬエラーが発生しました。原因究明のため、記載した値をお問い合わせフォームよりお知らせください。

注意事項

WebAPIをコールする環境について

閲覧者がページを開くたびにWebAPIをコールするご利用方法はシステム上想定しておりませんのでお控えください。

※この方法で行う場合はスマートライセンス・プランをご利用ください。

使用できるフォントについて

スマートライセンス・プランと異なり、ご利用できるフォントはご契約内容に準じます。ご契約内容をご確認ください。

外部へのアクセスについて

弊社都合によりhttps://s3-ap-northeast-1.amazonaws.com/へのアクセスが発生しますがご了承ください。