ヘルプセンター統合

のために: 管理者

APIキーを作成する

管理パネルのAPI用の管理キー、またはポータルのAPI用のハブキーを作成し、それを自分のIPアドレスに限定して、一度コピーしてください。

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

APIキー鍵 統合機能で作成される秘密のトークンで、これを使用することで、独自のソフトウェアがハブのAPIを利用できるようになります。とは、自分のソフトウェア(例えば、ケース管理システムなど)が、そのハブと連携できるようにするためのものです。管理用のキーは、アドミンパネルのAPIを利用して、ケースや人々を管理します。一方、ハブ用のキーは、ポータルのAPIを利用して、ケース内での作業を行います。APIが何をできるかを理解しましょう

  1. オープンキー

    行きましょう。 統合 › キー そして、選ぶことです。 新しい.

  2. 名前をつけて

    説明の下で、例えば「Case sync」など、その値をどのように使用するかを記述してください。

  3. 使用場所を制限する

    ソースCIDRの下に、自分のシステムがアクセスする公開IPv4アドレスを入力します。例えば、203.0.113.10などです。また、203.0.113.0/24のような範囲も指定できます。他の場所からのアクセスは拒否されます。ハブはIPv4アドレスのみを認識するため、IPv6アドレスは受け付けられません。

    もし、まだ住所を知らない場合は、その欄を空にしておきます。そうすると、どんな住所でも入力できます。システムが最初に呼び出された後です。 最後に使用されたIPアドレス それが示されているよ。見てみてください。 APIキーを制限したり、無効にしたりする.

  4. タイプを選択してください

    ドメインの下で、管理パネルのAPIの場合は管理を選択し、ポータルのAPIの場合はハブを選択してください。後から変更することはできません。

  5. スイッチを入れて追加する

    アクティブを使用します。このキーを有効にしておきます。無効なキーを使用すると、各コールで拒否されます。キーを追加を選択してください。「キーが追加されました」と表示されます。

  6. キーをコピーする

    シークレットキーウィンドウには、そのキーが一度だけ表示されます。次に、「コピー」ボタンを選択し、クリップボードにコピーというキーをコピーしてください。そして、そのキーを、開発者が安全にアクセスできる場所に保存しましょう。例えば、パスワードマネージャーなどです。その後、「できた」を選択します。

次に何が起こるのか

重要な作品を一度に送信でき、有効期限もありません。開発者が各呼び出し時にこれを送信します。詳細はこちらをご覧ください。 APIリクエストを認証するには、キーが必要です。. それは、あなたのハブとして機能します。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, つまり、彼が投稿した内容は、バーチャルアシスタントのものであることがわかります。

最終使用日と最後に使用されたIPアドレスには、最後に行われた呼び出しの日付やアドレスが表示されます。これを無効にしたり、削除したりするには、APIキーを制限または取消すを参照してください。

何か問題が発生した場合

  • 重要な制限値に達しました。 ホップには、各タイプのキーを2つ持つことができます。使用しなくなったタイプのキーの1つを削除してください。
  • Source CIDRによると、「アドレスブロックが有効ではないです。例:203.0.113.10や203.0.113.0/24」とのことです。 アドレスを確認してください。0から255までの数字で構成され、その間に点があるものです。また、範囲を示す場合はスラッシュと、最大32までの数字を使用します。
  • CIDRの情報によると、「203.0.113.10などのIPv4アドレスや範囲を使用してください。このAPIには、IPv4のみでアクセスできます。」とあります。 IPv6アドレスを入力しました。代わりに、自分のシステムのIPv4アドレスを使用してください。
  • キーを失ってしまいました。 もう、そのキーは使えません。新しいキーを作成し、システムをそちらに移動させてから、古いキーを削除してください。もし、ハブにすでに同じタイプのキーが2つある場合は、先に古いキーを削除してください。新しいキーがなければ、システムはハブに接続できません。

関連記事

キーを使用してAPIリクエストを認証する管理キーを取得するには、キーをベアラートークンとして管理パネルのAPIに送信するか、ハブキーを取得するにはポータルのAPIに送信し、アクセスを自分のIPアドレスに限定してください。統合APIキーを制限または取り消すキーを特定のIPアドレスに制限したり、無効にしたり、削除したり、最後に使用された日時を確認したりできます。統合 · 2 minAPIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合