カテゴリー
Open API
Open APIとは
Channel Open APIを利用することで、サードパーティ開発者は当社が現在提供する連携機能よりも複雑な方法でチャネルとやり取りするアプリケーションを構築できます。APIを活用することで、開発者はチャネルとの高度な連携やシームレスなパイプラインを自由に構築可能です。例えば、条件が満たされた際に顧客に自動応答するチャットボットなどが挙げられます。 公式ドキュメントは https://api-doc.channel.io/ でご覧いただけます。
Authentication
すべてのOpen APIには認証が必要です。 認証情報の取得 チャネル管理画面で、[チャネル設定] - [セキュリティ・開発] - [API管理] で、[＋新しい認証キーを作成] をクリックします。API認証情報に名前を付けて [確認] を押します。 Access KeyとAccess Secretのセットを含むAPI認証情報を作成できます。 API認証情報をテストする 新しく作成した認証情報はこちらでテストできます。ナビゲーションバー上部のフィールドに2つのキーを入力し、「Explore」をクリックするだけです。これで、すべてのAPIを試す準備が整いました！👍 API認証情報の使用方法 製品でOpen APIを利用するには、HTTPリクエストのヘッダーにx-access-keyフィールドとx-access-secretフィールドとして、それぞれAccess KeyとAccess Secretの値を含める必要があります。 curl -X GET "https://api.channel.io/open/v5/channel" -H "accept: application/json"
Rate Limiting
すべてのOpen APIはレート制限ポリシーの対象となります。チャネルからのAPIリクエストは、短時間に過剰なリクエストが受信された場合、スロットリングされ、HTTPステータス429 Too Many Requestsを返します。APIによって異なるレート制限の制約が適用される場合があります。 リクエストのレート制限ステータスの確認 Open APIリクエストのレスポンスHTTPヘッダーには、リクエストの（予想される）結果が記述されます。 curl -i https://api.channel.io/open/v5/... > HTTP/2 200 > x-ratelimit-limit: 1000 > x-ratelimit-remaining: 999 > x-ratelimit-reset: 1696118400 curl -i https://api.channel.io/open/v5/... > HTTP/2 429 > x-ratelimit-limit: 1000 > x-ratelimit-remaining: 0 > x-ratelimit-reset: 16961
Bot
3件の記事
UserChat
8件の記事
Channel
1件の記事
Group
7件の記事
Manager
2件の記事
Marketing
8件の記事
Plugin
3件の記事
User
10件の記事
Webhook
5件の記事
Event
3件の記事
Redirection
1件の記事