/
CloudGear APIについて
CloudGear APIについて
CloudGearでは、サービス提供者がサービスアプリケーションにCloudGearの機能を統合できるようWebAPIを提供しています。
APIの利用には、適切な権限が付与されたアクセストークンが必要です。アクセストークンの取得方法は、利用するAPIの区分によって異なります。
APIの区分
CloudGearが提供するAPIは、どの主体によってAPIが実行されるべきかによって2つの区分に分類されます。以下が区分の説明です。
User Subjective API | サービスの特定の利用者が主体となり実行されるAPIの区分です。例えば、ユーザー招待APIはスクエア管理者のロールを持つユーザーの立場により実行される必要があります。 この区分のAPIの実行には、Authorization Codeフローによって取得される特定ユーザーに紐づくアクセストークンが必要です。 |
Service Subjective API | 特定のサービスが主体となり実行されるAPIの区分です。例えば、使用量報告APIはユーザーの使用量を集計しているサービスの立場により実行される必要があります。 この区分のAPIの実行には、Client Credentialsフローによって取得される特定サービスに紐づくアクセストークンが必要です。 |
APIの利用制限
CloudGearでは、サービスアプリケーションで不必要に短周期のAPIリクエストは行わないよう推奨しています。異常な量のリクエストが検知された場合、運営チームによりAPIの利用が制限される場合があります。
Related content
APIクライアントの設定
APIクライアントの設定
More like this
サービス定義の使用実績をAPIで報告する
サービス定義の使用実績をAPIで報告する
More like this
サインアップ
サインアップ
More like this
WebHookの基本
WebHookの基本
Read with this
サービス利用規約の設定
サービス利用規約の設定
More like this
クーポンを発行する
クーポンを発行する
Read with this