コンテンツへスキップ
Wbiztool

製品ガイド

APIキー

Wbiztool APIや、認証情報を求める連携を使用するには、ダッシュボードから次の3つの情報が必要です。

認証情報APIのフィールド確認場所
APIクライアントIDclient_id設定 → APIキーのページ上部
APIキーapi_key設定 → APIキー
WhatsAppクライアントIDwhatsapp_clientWhatsApp設定の WhatsAppクライアントID 列

始める前に#

  • APIキーの表示、作成、削除には、ワークスペースの 管理者 である必要があります。ロールと権限をご覧ください。
  • 先に正しいワークスペースを選択してください。キーは作成時に選択されているワークスペースに属し、そのキーを使ったAPIリクエストはそのワークスペースに対して実行されます。ワークスペースを切り替えるをご覧ください。
  • デモアカウントではAPIを使用できません。

APIクライアントIDを確認する#

設定 → APIキーを開きます。API概要 カードに、APIクライアントID： の後に続けて数字が表示されます。この数字をすべてのリクエストで client_id として使用します。ワークスペース内のすべてのキーで同じ値です。

APIキーを作成する#

  1. APIキーを開く

    設定にアクセスして APIキー タブをクリックするか、/settings/#api-keys を直接開きます。

  2. キーを作成する

    新しいAPIキー の下にある 新規作成 をクリックします。キーが生成されたことを知らせる成功メッセージが表示され、キーが表に追加されます。

  3. キー全体をコピーする

    APIキー 列には、各キーの先頭と末尾のみが表示されます。隣にあるコピーボタン（フルAPIキーをコピー）をクリックしてキー全体をコピーし、アプリや連携に貼り付けます。

キーには、ワークスペースにあるキーの数に基づいて自動的に名前（API Key 1、API Key 2 など）が付けられ、名前は変更できません。キーを削除した後に作成したキーには、既存のキーと同じ名前が付くことがあるため、キーは先頭と末尾の文字と 作成済み の日付で区別してください。キーに有効期限はなく、削除するまで使用できます。

上限#

1つのワークスペースで同時に保持できるAPIキーは最大 10 個です。上限に達すると、「You have reached the maximum limit of 10 API keys per organization.」（組織あたりのAPIキーの上限10個に達しました）と表示されます。新しいキーを作成するには、使用していないキーを削除してください。

APIキーの表#

列意味
ラベルAPI Key 1 などのキーの名前。
APIキーキーの最初と最後の数文字。キー全体はコピーボタンで取得します。
作成済みキーが作成された日付。
ステータス常に アクティブ です。削除したキーは表から消えます。
アクション削除 でキーを削除します。

APIキーを削除する#

  1. キーを探す

    設定 → APIキーの表でキーを探します。

  2. 削除する

    削除 をクリックし、はい、APIキーを削除します をクリックします。

キーの削除は元に戻せません。そのキーをまだ使用しているアプリはすぐに動作しなくなり、Auth Error: invalid api key が返されます。先にアプリを新しいキーに更新してください。

WhatsAppクライアントID#

接続済みの各WhatsApp番号には、それぞれIDがあります。ほとんどのメッセージ送信エンドポイントでは、どの番号から送信するかを指定するために、このIDを whatsapp_client フィールドに指定する必要があります。

WhatsApp設定を開き、各番号の WhatsAppクライアントID 列を確認してください。まだ番号を接続していない場合は、WhatsApp番号を接続するをご覧ください。

認証情報をテストする#

client_id と api_key、必要に応じて whatsapp_client を指定して、認証情報の確認（POST /api/v1/me/）を呼び出します。何も送信せず、メッセージも消費せずに、これらの組み合わせが正しく機能することを確認できます。whatsapp_client がワークスペースに属していない場合、レスポンスは Invalid WhatsApp Client ID になります。

APIキーが漏えいした場合#

APIキーとAPIクライアントIDを知っている人は誰でも、あなたのWhatsApp番号からメッセージを送信し、ワークスペースのメッセージを消費できます。

  1. 代わりのキーを作成する

    設定 → APIキーで 新規作成 をクリックし、新しいキーをコピーします。

  2. アプリを更新する

    古いキーを使っていたすべてのアプリと連携で、キーを置き換えます。

  3. 漏えいしたキーを削除する

    漏えいしたキーの 削除 をクリックします。キーはすぐに使えなくなります。

  4. 不正利用がないか確認する

    レポートで最近のメッセージを確認し、送信した覚えのないものがないか確認します。

また、「WbizTool Alert - WhatsApp Connected Successfully!」というメールも秘密情報として扱ってください。このメールは番号が初めて接続されたときにワークスペースの作成者に送信され、APIキーの1つが記載されている場合があります。

トラブルシューティング#

問題確認事項
キーがあるのに、APIキー タブに APIキーが見つかりません と表示されるこのワークスペースの管理者ではないか、別のワークスペースが選択されています。
「You don't have permission to create API keys in this space.」（このスペースでAPIキーを作成する権限がありません）キーを作成・削除できるのは管理者のみです。表が空のときに表示される 新しいAPIキーを生成 ボタンは全員に表示されますが、機能するのは管理者の場合のみです。
「You have reached the maximum limit of 10 API keys per organization.」使用していないキーを削除してください。
Auth Error: invalid api keyキーが削除されたか入力を誤っているか、client_id がキーと同じワークスペースのものではありません。新しいキーとページに表示されている APIクライアントID を使っても失敗する場合は、サポートにお問い合わせください（古いワークスペースでは、ワークスペースの作成者が作成したキーでしか使えないAPIクライアントIDが表示されることがあります）。
Auth Error - Please send correct API key and Client idリクエストに api_key が含まれていません。
Invalid client id.（一部のエンドポイントでは Invalid Client Id）client_id がないか、数字ではありません。認証情報の確認では、client_id または api_key がない場合は Auth Error のみが返され、Invalid Client Id は数字ではないことを意味します。API概要 カードからコピーしてください。
リクエストが別のワークスペースに対して実行されるキーが別のワークスペースで作成されています。ワークスペースを切り替えて、そこでキーを作成してください。
Demo Account can not access apisデモアカウントではAPIを使用できません。無料アカウントに登録してください。

関連情報#