REST API 仕様書（Swagger）の操作マニュアル
このページではREST API 仕様書（Swagger）の操作方法をご案内します。
１．REST APIのバージョン選択
右上の「Select a definition」のドロップダウンリストより、REST APIのバージョンが選択できます。
２．REST APIの仕様へのリンク
タイトルの下に、REST APIの仕様（JSON形式）へのリンクがあります。
３．REST APIのリクエストコードの取得方法
- gBizINFO REST API、およびgBizINFO REST API (Period-specified Search)項目配下に、REST APIのエンドポイントがあります。
-
項目のドリルダウンを開くことで、エンドポイントの一覧が表示されます。
-
エンドポイントのドリルダウンを開くことで、各パラメータの詳細が表示されます。
-
右にある[Try it out]ボタンを押下することで、パラメータの入力項目が活性化され値を入力できるようになります。
[Try it out]ボタンを押下前
[Try it out]ボタンを押下後
-
パラメータ項目（※APIトークンは必須項目）に値を入力し[Execute]を押下することで、Responses配下にリクエストコードが出力されます。
４．パラメータの仕様確認
-
入力値のパラメータの仕様確認
①gBizINFO REST API、およびgBizINFO REST API (Period-specified Search)項目の確認したいエンドポイントのドリルダウンを開きます。
②Parameters項目で各パラメータの入力値の仕様を確認いただけます。
-
出力値のパラメータ仕様確認
①gBizINFO REST API、およびgBizINFO REST API (Period-specified Search)項目の確認したいエンドポイントのドリルダウンを開きます。
②Responses項目配下のDescriptionの[Schema]を押下します。
③確認したい項目のドリルダウンを開くことで、各パラメータの出力値の仕様を確認いただけます。