ヘルプセンター統合

のために: 管理者

APIで何ができるかを理解しましょう

管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。

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

このAPIを使えば、例えばケース管理システムなどの独自のソフトウェアを、誰もスクリーンを操作しなくても、ハブと連携させることができます。このAPIは「APIキー鍵 統合機能で作成される秘密のトークンで、これを使用することで、独自のソフトウェアがハブのAPIを利用できるようになります。」と呼ばれ、2種類があります。1つは、管理パネルの機能を実行するための「管理用キー」であり、もう1つは、ケース内での処理を行うための「ハブ用キー」です。

仕組み

2つのキー、2つのAPIです。 各キーは、それぞれ自分自身のアドレスを呼び出します。その後、ハブのIDが続きます。そして、他のキーによって拒否されます。

鍵住所それが到達するもの
重要なことを管理するhttps://prd-api-manage.caseactive.com/v1/<hub id>/ケースや、そこに関わっている人々、彼らのアクセス権、役割、進行状況、検索方法、そして読むべき請求書についてです。インポートの処理は https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ で行われています。
Hubキーhttps://prd-api-app.caseactive.com/v1/<hub id>/各ケース内のすべての情報:投稿やコメント、ファイル、フォーム、電子署名、タスク、請求書、イベントの情報、メモ、そしてそのケースの詳細情報です。

管理キーが呼び出せるものは、これだけです。 その他の呼び出しは、Admin PanelのAPIでは403 BotNotAllowedExceptionというエラーが返されます。

すべてのキーは、あなたのバーチャルアシスタントです。 あなたのハブとなる場所の重要な兆候です。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。. その情報は、バーチャルアシスタントの名前やバッジの下に表示されます。変更された内容も、バーチャルアシスタントのものとして記録されます。バーチャルアシスタントは、すべての案件に関与しています。そのため、ハブキーを使えば、どの案件にもアクセスできます。バーチャルアシスタントの機能に従って操作を行うことができますが、デフォルトでは、スタッフが行える操作のみが可能です。また、終了した案件については、バーチャルアシスタントには読み取り専用の権限しかありません。ハブキーを使って新しい案件を作成したり、人を追加したり、請求書を支払ったり、問い合わせに応答したりすることはできません。

キーは有効期限がない。 キーは、管理者がそれを無効にしたり、削除したりするまで有効です。各キーは、システムの公開IPv4アドレスに制限されています。詳細については、APIキーの使用制限や取消しについてをご覧ください。

技術的なページです。 各APIは、ログインなしで、その機能の詳細な情報を表示します。

キーの管理ハブキー
インタラクティブな機能(Swagger UI)https://prd-api-manage.caseactive.com/https://prd-api-app.caseactive.com/
参照情報(ReDoc)https://prd-api-manage.caseactive.com/redochttps://prd-api-app.caseactive.com/redoc
OpenAPIドキュメントhttps://prd-api-manage.caseactive.com/openapi.jsonhttps://prd-api-app.caseactive.com/openapi.json

そのアプリが自動的に行うすべての通話のリストが表示されます。その中には、管理キーでは実行できないような通話も含まれています。上記のリストには、管理キーで実行可能な通話が何かが記載されています。インタラクティブページで通話を試すには、「承認する」を選択し、自分の管理キーを貼り付けてください。

ロックされたハブです。 支払いに失敗した後、ハブの管理パネルはロックされます。その場合、管理キーを使用してアクセスしようとすると、403 ManageBillingInactiveExceptionエラーが発生します。ハブキーは、ポータルが読み取り専用状態になるまで有効です。支払いが未完了の場合は、14日後、またはサブスクリプションがキャンセルされた日まで有効です。その後は、ハブキーを使用してもアクセスできますが、すべての変更は403 BillingReadOnlyExceptionエラーで拒否されます。この状態は、管理者がサブスクリプションを再起動するまで続きます。

いつ使うべきか

管理キーを使って、自分のシステムと他のシステムとの連携を維持できます。ケースを作成したり、顧客を追加したり、その顧客をケースに登録したりすることができます。また、人が退職した場合には、その人のアクセス権を取り消すこともできます。さらに、ファイルから複数のデータを一度に読み込むこともできます。また、自分のソフトウェア内でケースを操作するためにも、ハブキーを使用できます。例えば、システムに何か変更があった場合には、その情報を記録することができます。

変化が起こった際に、その変化を自動的に知るために、ウェブホックを利用しましょう。詳細は ウェブホックの設定方法をご覧ください。キーを作成するには、APIキーの作成を参照してください。

関連記事

APIキーを作成する管理パネルのAPI用の管理キー、またはポータルのAPI用のハブキーを作成し、それを自分のIPアドレスに限定して、一度コピーしてください。統合 · 5 minキーを使用してAPIリクエストを認証する管理キーを取得するには、キーをベアラートークンとして管理パネルのAPIに送信するか、ハブキーを取得するにはポータルのAPIに送信し、アクセスを自分のIPアドレスに限定してください。統合フィードアクティビティ用のウェブフックを設定するフィードの投稿、コメント、添付ファイルが追加、変更、削除されるたびに、独自のシステムにメッセージを送信します。統合 · 10 minAPIエラーとステータスコードを処理するエラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。統合