コンテンツへスキップ
Wbiztool

スタートガイド

認証情報の確認API

ほかのAPIを呼び出す前に、このAPIで認証情報を検証できます。client_idapi_keyの組み合わせが有効であること、また必要に応じてWhatsApp番号のIDがワークスペースに属していることを確認します。メッセージは送信されず、クレジットも消費しません。

POSThttps://wbiztool.com/api/v1/me/

リクエストボディ: JSONまたはフォームフィールド

クイック例#

curl -X POST https://wbiztool.com/api/v1/me/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

12345YOUR_API_KEY678はご自身の値に置き換えてください。APIキーだけをテストしたい場合はwhatsapp_clientを省略してください。値の確認場所は認証をご覧ください。

リクエストパラメータ#

client_idinteger必須

設定 → APIキーに表示されるAPIクライアントIDです。

api_keystring必須

同じページにあるAPIキーです。

whatsapp_clientinteger任意

WhatsApp設定に表示される、いずれかのWhatsApp番号のIDです。送信すると、そのIDがこのAPIキーのワークスペースに属しているかどうかもあわせて確認します。ダッシュボードから削除した番号でも、この確認は通過します。確認するのはIDのみで、番号が接続されているかどうかはわかりません。接続状態は接続ステータスで確認してください。

レスポンス#

リクエストが成功すると、HTTP 200が返ります。

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
フィールド説明
statusinteger認証情報が有効な場合は1、無効な場合は0
messagestring成功時はOkay、それ以外はエラー内容。
namestringワークスペースを作成した人のユーザー名。whatsapp_clientを送信した場合は、-の後にその番号の電話番号が付加されます。成功時のみ含まれます。

エラー#

このエンドポイントの失敗はすべてHTTP 400で返ります。ただし、client_idが数値でない場合はHTTP 403が返ります。ボディのstatusは常に0です。

{ "status": 0, "message": "Auth Error: invalid api key" }
メッセージ対処方法
Auth Errorclient_idapi_keyの両方を、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。whatsapp_clientが数値でない場合にもこのメッセージが表示されます。
Invalid Client Idclient_id12345のような整数で送信してください。
Auth Error: invalid api keyキーが存在し、削除されておらず、このclient_idに属していることを確認してください。
Invalid WhatsApp Client IDそのwhatsapp_client IDはこのAPIキーのワークスペースにありません。WhatsApp設定からIDをコピーしてください。

APIの稼働確認#

/api/v1/status/はシンプルな死活監視用エンドポイントです。認証情報は不要で、どのメソッドでも受け付け、常に次の内容を返します。

{ "status": 200, "data": {} }

わかるのはAPIに到達できるかどうかだけです。認証情報や、WhatsApp番号が接続されているかどうかは確認しません。

curl https://wbiztool.com/api/v1/status/

Pythonクライアントのhealth_check()はこのエンドポイントを呼び出します。

ヒント#

  • 確認は設定時に1回:メッセージを送るたびではなく、ユーザーがアプリで認証情報を保存したときにこのエンドポイントを呼び出してください。確認が成功しても、送信できるとは限りません。残りのクレジットや番号が接続されているかどうかは確認されません。
  • エラー時もボディを読む:失敗はHTTP 400または403で返るため、その場合でもHTTPクライアントがJSONボディを解析するようにしてください。
  • 削除したキーはすぐに使えなくなるAPIキーのページでキーが削除されている場合、Auth Error: invalid api keyが返ります。
  • 次のステップ:認証情報が有効であることを確認したら、メッセージを送信しましょう。