ドキュメントを管理する

登録した商品に関するドキュメントを作成します。

他のユーザーが商品を使用できるようにこのドキュメントを共有することができます。

APIのOverview

APIに関する説明を Markdown 文法で作成します。

My Products > APIsメニューへ移動して Overview タブを選択します。

入力 タブを選択してドキュメントを修正できます。

プレビュー タブを選択して作成されたドキュメントをプレビューできます。

保存をクリックしてドキュメントを保存します。

StageのDocument

My Products > APIs > Stages メニューへ移動して Document タブを選択します。

プレビューをクリックして作成されたドキュメントをプレビューできます。

ProductのCatalog

商品に生成されたAPIの OverviewとDocumentを一つにまとめて表示します。

このドキュメントは他のユーザーと共有できます。

Catalog アイコンをクリックします。

① 掲示したStageがあるAPIリストを表示します。Stageを掲示する方法は以下の"Catalogを掲示する"をご参照ください。

② APIを選択すると Overviewが表示されます。

③ Stageに関するAPI明細をSwagger UIを通じてみることができます。

[修正] ボタンをクリックしてOverviewを修正できます。

Catalogを掲示する

Productを他のユーザーが利用できるようにドキュメントを掲示します。

My Products メニューへ移動して 掲示 アイコンをクリックします。

① API リストが照会されます。本人が掲示する APIを選択します。

② 掲示する Stageを選択します。

  • Stageが選択されていないAPIはCatalogに表示されません。
  • 全てのAPIのStageが選択されないとCatalogは他のユーザーに表示されません。

掲示 ボタンをクリックします。

  • Published APIs メニューへ移動して本人が掲示した商品と他のユーザーが掲示した商品を一緒に照会できます。

API Key を管理する

Productに接続されたAPI Keyを管理します。

My Products メニューへ移動してAPI Keys アイコンをクリックします。

API Keyの状態を変更する

状態を修正をクリックしてAPI Keyの状態を変更できます。

  • リクエスト: API Key 承認をリクエストした状態です。
  • リクエスト拒否: API Key 承認リクエストを拒否した状態です。
  • 承認: APIを呼び出しできる状態です。
  • 拒否: 承認された API KeyがAPIを呼び出しできないように拒否した状態です。

Usage PlansをクリックするとAPI Keysに接続されたUsage Plan情報を確認できます。

③ 商品に接続されたAPI Keyのリストを照会します。

API KeyのUsage Planを変更する

Usage Plan を修正をクリックしてAPI Keyに接続されたUsage Planを変更できます。

② API Keyが接続されたStageのUsage Planと使用量を確認できます。

① Stageに接続されたUsage Planの中で変更するUsage Planを選択します。

保存をクリックします。

に対する検索結果は~件です。 ""

    に対する検索結果がありません。 ""

    処理中...