APIキーによる認証

2つの価格エンドポイントを除くすべてのエンドポイントでは、AuthorizationヘッダーにAPIキーが必要です。

POST /v1/messages HTTP/1.1
Host: bulksmsapi.cc
Authorization: Bearer bsa_live_7QzX2mW9kR4tB8nV1cJ6yP3sH5dL0aFe
Content-Type: application/json

キーの作成

• キーはコンソールのAPIキーページで作成されます。このページは、最初のチャージが残高に追加された後に開きます。
• 1つのアカウントで10個のアクティブなキーを保持できます。各アプリまたは環境に独自のキーと名前を付けて、他のキーに影響を与えずに1つを置き換えることができます。
• キーはbsa_live_の後に32文字の英数字が続きます。作成時に一度だけ表示されます。キー付きハッシュのみを保持するため、失われたキーは再度表示できません。代わりに新しいキーを作成してください。
• リストには、最初の文字、最後の4文字、キーが作成された日時、および最後に使用された日時が表示されます。

ローテーションと取り消し

ダウンタイムなしでキーをローテーションするには、2つ目のキーを作成し、デプロイし、コンソールで最後に使用された時間を確認してから、古いキーを取り消します。取り消されたキーは、次のリクエストから401 unauthorizedと応答します。

キーの安全な保管

• APIはサーバーから呼び出し、ブラウザやモバイルアプリからは呼び出さないでください。キーを持っている人は誰でもあなたの残高からメッセージを送信できます。
• キーはソース管理ではなく、環境変数またはシークレットマネージャーに保管してください。
• 各キーには独自のレートリミットカウンターがあるため、ビジーなワーカーが他の場所で使用されている2つ目のキーを遅くすることはありません。

エラー

{
  "error": {
    "code": "unauthorized",
    "message": "Send your API key as Authorization: Bearer bsa_live_... Keys are created in the console under API keys.",
    "doc_url": "https://bulksmsapi.cc/en/docs/errors#unauthorized"
  }
}