ヘルプセンター統合

のために: 管理者

キーを使用してAPIリクエストを認証する

管理キーを取得するには、キーをベアラートークンとして管理パネルのAPIに送信するか、ハブキーを取得するにはポータルのAPIに送信し、アクセスを自分のIPアドレスに限定してください。

この記事では5 セクション

始める前に

このページでは、各種のAPIキー鍵 統合機能で作成される秘密のトークンで、これを使用することで、独自のソフトウェアがハブのAPIを利用できるようになります。をどこに送るべきか、どうやって送るか、そしてなぜそのキーが拒否されるのかについて説明しています。

住所

鍵ベースアドレス例
重要なことを管理するhttps://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
重要なインポートの管理を行うhttps://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
Hubキーhttps://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Hubキー、1つのケースです。https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

あなたのhub IDは、以下の通りです。 ca- そして、14文字です。そう表示されます。 ハブID その上で 概要 ポータル内の任意のケースについて、コピーするボタンがあります。ケースのIDも表示されています。 cc- そして、14文字です。そこに表示されているのは… ケースID.

キーを送信しています

各呼び出しのAuthorizationヘッダ内に、Bearerの後にスペースを付けて、その鍵を送信してください。

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Content-Type: application/jsonを使って、JSON形式のデータを送信してください。
  • キーは有効期限がない。管理者がそのキーを無効にしたり、統合 › キーから削除したりするまで、そのキーは有効なままです。
  • すべてのコールサインが再設定されています。セッションやトークンを交換する必要はありません。
  • 日付や時間は、UTC形式で表示されます。

使用場所を制限する

ソースCIDRの下では、APIキーを、システムの公開IPv4アドレスに限定することができます。例えば、203.0.113.10のようなアドレスです。また、203.0.113.0/24のような範囲も指定できます。このAPIはIPv4接続のみを扱うため、IPv6アドレスや範囲を指定して保存すると拒否されます。他の場所からの呼び出しは、401 LoginSourceIpExceptionというエラーコードで拒否されます。範囲を変更するには、APIキーの制限または無効化を参照してください。

キーが拒否された場合

どんな拒否も、実際にはエラーの一種として戻ってきます。 message その名前を付けることです。詳しくはこちらをご覧ください。 APIエラーやステータスコードを処理する.

状態messageなぜ何をするか
401Unauthorizedキーが送信されなかった、または送信されたものがキーではない。Authorizationヘッダを確認してください。
401HostNotFoundExceptionアドレスに含まれるハブIDは、存在しません。もう一度、ハブIDをコピーしてください。
401HostPurgingExceptionハブが削除されます。ご自身のハブにある管理者に尋ねてみてください。
401SessionNotFoundExceptionそのキーが削除されてしまったか、または他のハブに属しているようです。このハブには、現在使われているキーを使用してください。
401LoginKeyInactiveExceptionキーがオフになっています。管理者に、その機能を有効にしてもらうようお願いしましょう。
401LoginKeyWrongApiException管理用のキーが、ハブキーのアドレスに送信されました。あるいは、その逆も同様です。キーの種類に合わせて、そのアドレスを使用してください。
401LoginSourceIpExceptionその電話は、鍵の使用可能範囲外からかかってきました。許可されているアドレスから通話をかけるか、通信範囲を広げてください。
401LoginSourceCidrExceptionキーの保存されている範囲を読み取ることができません。正しい ソースCIDR
403BotNotAllowedException「管理キー」という名前のキーがありますが、そのキーを使うことができません。APIが何をできるかを理解してください。
403ManageBillingInactiveException支払いに失敗した後、ハブの管理パネルがロックされています。(キーを使ってのみアクセス可能です。)管理者に、支払い方法を更新してもらうように依頼してください。
403BillingReadOnlyExceptionあなたのハブのサブスクリプションが切れてしまい、そのポータルは読み取り専用になっています。ですから、ハブキーを使っても何も変更することはできません。管理者に、サブスクリプションの再起動を依頼してください。
403CaseClosedExceptionHubキーを使って、閉じられたケースを変更しようとした。まず、そのケースを再開してください。
404CaseNotFoundException「hub key」という名前のキーが、実際には存在しない、またはあなたのhubに存在しないケースを指しています。ケースIDを確認してください。
503LoginSessionExceptionハブは忙しすぎて、そのキーを確認することができなかった。もう少し時間をください。再試行しましょう。

401というコードは、キー自体が拒否されたことを意味します。そのため、同期処理が停止し、何者かが警戒する可能性があります。他のエラーは、通話に関するものです。

関連記事

APIエラーとステータスコードを処理するエラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。統合APIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合APIキーを制限または取り消すキーを特定のIPアドレスに制限したり、無効にしたり、削除したり、最後に使用された日時を確認したりできます。統合 · 2 min