すべてのプロダクト
Search
ドキュメントセンター

:API の公開

最終更新日:Mar 20, 2020

API の公開

本セクションでは、API サービスを公開する前に、理解しておく必要のある API グループおよびドメイン名について説明します。

API グループ

API グループは、API の管理単位です。 API を作成する前にグループを作成する必要があります。 グループは、名前、説明、リージョン、ドメイン名の 4 つの属性で構成されます。 以下にご注意ください。

  • グループ リージョンは一度選択すると変更することはできません。

  • 各アカウントは最大 50 の API グループ、各 API グループは最大 200 の API を持つことができます。

  • グループを作成すると、システムはそのグループにサブドメイン名を割り当てて API を検証できます。 API サービスを公開するには、独自ドメイン名にグループをバインドし、独自ドメイン名の CNAME をグループのサブドメイン名に解決する必要があります。 最大 5 つの独自ドメイン名をグループにバインドできます。(中国でビジネスを展開する場合、独自ドメイン名はICPライセンスを取得する必要があります)

ドメイン名および証明書

API Gateway はドメイン名から一意の API グループを特定し、Path+HTTPMethod で一意の API を特定します。 API サービスを公開する前に、サブドメイン名および独自ドメイン名について知っておく必要のある点は次のとおりです。

  • 一意で固定のサブドメイン名は、グループの作成時にシステムによって割り当てられます。 そのサブドメイン名は、トラフィックの少ないテスト環境で API の呼び出しテストのためだけに使用されます。デフォルトでは、1日に1000回の使用制限があります。
  • API サービスの公開には、独自ドメイン名が使用されます。 最大 5 つの独自ドメイン名をグループにバインドできます。 独自ドメイン名を設定する場合は、次の点にご注意ください。

    • 独自ドメイン名の CNAME を API のサブドメイン名に解決してから、API グループとドメイン名をバインドします。

    • 1 日以内にドメイン名を検証します。 検証しない場合、システムは未処理のバインド要求を自動的に取り消します。

    • 独自ドメイン名はトップレベルドメインではなく、第二レベルドメイン、 第三レベルドメインでもご利用可能です。

API が HTTPS プロトコルをサポートしている場合は、グループの詳細ページで、パラメーター(名前、コンテンツ、および秘密鍵を含む)を入力(証明書ファイルのアップロードは現在サポートしていません)して、ドメイン名の SSL 証明書を追加する必要があります。

検証、製品化、認証

API を検証または公開するには、承認が不可欠です。承認とは、アプリに API を呼び出す権限を付与することです。 以下にご注意ください。

  • API の呼び出しにサブドメイン名にアクセスできるよう、作成したアプリを承認して、テストすることができます。
  • API の呼び出しに独自ドメイン名にアクセスできるよう、ユーザーのアプリを承認して、公開することができます。
  • 権限付与したアプリしか API を呼び出すことはできません。

これで、API サービスが公開されました。 API の作成から公開まで、API の作成、変更、削除、表示、検証、本番リリース、削除、権限の付与および取り消しを行うことができます。 また、リリース履歴を表示し、バージョンを切り替えることもできます。