Published APIs

Prev Next

Classic/VPC環境で利用できます。

ProductのAPI文書を共有したり、他のユーザーが共有したAPI文書をサブスクリプションできます。

参考

作成したProductのAPI文書を公開、確認及び管理する方法は、My ProductsメニューのCatalogの確認をご参照ください。

Published APIs画面とリスト

API Gatewayの利用のためのPublished APIsメニューの基本的な説明は以下のとおりです。

apigw-publishedapis-list_ja

領域 説明
① メニュー名 現在確認中のメニュー名、サブスクリプションできるProduct数
② 基本機能 API Gatewayの詳細情報を確認、ページの更新
③ Catalog ユーザーと他のユーザーが共有したAPI文書の確認とサブスクリプション
④ 検索ウィンドウ Product名を入力した後、i-apigateway-findをクリックして項目を検索
⑤ フィルタ API提供位置(デフォルト値：NCP)、サブスクリプションの有無を基準に項目をフィルタリング
  • NAVERクラウドプラットフォームで提供するAPI以外に、他のAPIリストを照会するにはフィルターを変更
  • ユーザーが公開したAPIを検索するには Myを選択
⑥ ソート リストのページごとに表示するAPI数の設定
⑦ リスト ユーザーと他のユーザーが共有したAPIリスト
  • Product名：公開されたProduct名
  • 説明：公開されたProductに関する説明
  • サブスクリプション方式：公開されたProductのサブスクリプション方式(公開、 保護)
  • サブスクリプション：公開されたProductに対するユーザーのサブスクリプション有無

Catalogを見る

Productに作成されたAPIのOverviewを確認して、StageのDocumentをSwagger UIで確認できます。
ユーザーが公開したAPIの場合、Overviewの内容を修正できます。

公開されたAPIのOverviewとDocumentを確認する方法は以下のとおりです。

  1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
  2. Published APIsメニューをクリックします。
  3. 公開されたProductリストで情報を確認するProductをクリックして選択した後、[Catalog] ボタンをクリックします。
    • NAVERクラウドプラットフォームで提供するAPI以外の他のAPIリストを照会するには、フィルタのProduct項目を変更します。
  4. ProductのCatalogリストで確認するAPI名をクリックします。
  5. 照会の詳細画面でAPIのOverviewとStageのDocumentを確認します。
    • ユーザーが直接作成したAPIの場合、Overviewの内容を修正できる [修正] ボタンが表示されます。 修正するには、[修正] ボタンをクリックして内容を作成した後、[保存] ボタンをクリックします。 Overviewの作成についての詳細は、API説明書のOverviewの作成をご参照ください。
    • StageのDocumentの内容をSwagger UIで確認するには、Stage名またはi-apigateway-viewをクリックします。

Catalogのサブスクリプションの申し込み

公開されたProductのサブスクリプション方式は、公開と保護があります。

  • 公開：承認の手続きなしに誰でもProductのAPIを呼び出すことができ、Catalogリストの画面に [サブスクリプション] ボタンが表示されない
  • 保護：ProductのAPIを使用するためには公開者の承認が必要で、Catalogリストの画面に [サブスクリプション] ボタンが表示される

公開されたProductのサブスクリプション方式が保護の場合、サブスクリプションするにはAPI Keyの作成をした後、API Keyの承認手続きをする必要があります。

Catalogサブスクリプションの申込方法は以下のとおりです。

  1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
  2. Published APIsメニューをクリックします。
  3. Published APIsメニューでサブスクリプションタイプが保護であるProductをクリックして選択した後、[Catalog] ボタンをクリックします。
  4. ProductのCatalogリストで [サブスクリプション] ボタンをクリックします。
  5. サブスクリプションを申し込むAPIに対して認証されるAPI Keyを選択した後、[サブスクリプションのリクエスト] ボタンをクリックします。
  6. サブスクリプションのポップアップで、[サブスクリプションリクエスト] ボタンをクリックします。
    • サブスクリプションの申し込みが完了すると、Productのサブスクリプション列の表示値がサブスクリプション前からリクエストに変更されます。
    • サブスクリプションの状態は、API Keysメニューの接続したStageリストで確認できます。
    • APIサブスクリプションの状態に関する詳細は、API Keyの状態の変更をご参照ください。
    • APIサブスクリプションをキャンセルするには、API KeysメニューのStageの接続を解除(サブスクリプションのキャンセル)をご参照ください。