サポート

よくある質問

API の使用

API を使用したいだけの場合のプランとは

プランとは、API リソース、または 1 つ以上の API のリソースのサブセットの集合です。プランには、複数の API の操作タイプを混在させて含めることができます。プランでは、すべてのリソースに共通のレート制限を設定することも、各リソースに異なるレート制限を設定することもできます。レート制限は、指定した時間間隔内に 1 つのアプリケーションが出すことを許可される要求数を指定します。

この開発者ポータルを使用して、自分が使用できるさまざまなプランを表示し、要件に最も適したプランを選択します。一部のプランへのアクセスは制限されているため、使用するにはアクセス権限を要求する必要があります。このような要求を送信すると、組織に通知され、API 管理者が要求を評価します。管理者から詳細を照会される場合があります。その他のプランは、すぐに使用できます。

API の使用量を知るには

各種の API に対してアプリケーションが実行した要求の数はアプリケーション・ページに表示されます。

メインメニューの「アプリケーション」をクリックしてから、対象アプリケーションをクリックしてください。「製品のサブスクリプション」表に、アプリケーションがサブスクライブしているすべてのプランが表示されます。

そのプランに含まれる API ごとに、プランのレート制限と比較した使用量が表示されます。

API をテストするには

この開発者ポータルから API をテストできます。

API の詳細を表示させると、その API に含まれる操作のリストが表示されます。ここには、その操作に使用する verb とパスが表示されます。

操作をクリックすると、詳細情報、取るパラメーター、戻り値、考えられる戻りコードとその意味が表示されます。

REST API への「Try」ボタンも用意されており、開発者ポータルから直接操作を実行してみることができます。

API で識別のためにクライアント ID またはクライアント・シークレットが必要な場合は、「Try」セクションの上部でアプリケーションの資格情報を使用して指定できます。

アプリケーション

アプリケーションを登録するには

アプリケーションを追加すると、そのアプリケーションの API キーと秘密鍵が与えられます。アプリケーションの認証を必要とする API を呼び出す際には、これらの資格情報を指定する必要があります。

アプリケーションを登録するには、メインメニューの「アプリケーション」をクリックし、「新しいアプリケーションの作成」のリンクをクリックします。アプリケーション名や説明などを入力すると、アプリケーションの API キーと秘密鍵が表示されます。

API 秘密鍵が表示されるのは 1 回のみなので、書き留めておいてください。

アプリケーションの API 秘密鍵をリセットするには

API 秘密鍵は暗号化して格納されるため、忘れてしまったときに、当社で暗号化する前の値に戻してお知らせすることができません。

リセットすると、格納されている値が更新され、新しい値が返されます。

そのためには、メインメニューの「アプリケーション」をクリックし、対象のアプリケーションをクリックし、「API 秘密鍵」セクションにある「リセット」のリンクをクリックしてください。

新しいシークレットがページの上部に表示されます。