ログイン

/v1/users/login

WhatsApp Business APIクライアントで自分自身を認証するには、ログインする必要があります。ログインするには、基本認証を使用してユーザーネームとパスワードを送信し、ベアラートークンを応答で受信します。その後、リクエストをいずれかのWhatsApp Business APIエンドポイントに送信するときに、認証のためにそのベアラートークンを使用します。APIを使用するための認証について詳しくはこちら。

開始する前に

WhatsApp Business APIクライアントにはデフォルトのアカウントがあります。このデフォルトアカウントのユーザーネームはadmin、パスワードはsecretです。このアカウントはシステムから削除できません。セキュリティ上の理由から、初回ログイン時に管理者パスワードを変更する必要があります。

パスワードのおすすめ

新しいアカウントを作成するときや、新しいアカウントのパスワードを設定するときは、業界のベストプラクティスに従って、強力なパスワードを使用することをおすすめします。

パスワードは、8文字から64文字の長さにする必要があります。また、少なくとも以下の文字が含まれている必要があります。

• 1つの数字
• 1つの大文字
• 1つの小文字
• !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~の中から選択した1つの特殊文字

新規アカウントを作成する、または既存アカウントのパスワードを変更する際は、パスワードの複雑性が適用されます。

作成

ログイン時に基本認証(ユーザーネームとパスワード)を使用して、自分自身を認証します。HTTPヘッダーにAuthorizationが設定されます。typeはBasicで、credentialsは、usernameおよびpasswordをコロンで結合したbase64でエンコードされた文字列です(つまり、username:password)。

ログインリクエストがWhatsApp Business APIクライアントによって受信されると、認証情報が認証のために処理されます。

• 認証が成功すると、トークンが生成されます。トークンは応答のtokenフィールドに含まれています。
• 失敗すると、エラーが返されます。

例

初回ログイン

セキュリティ上の理由から、初回ログイン時には、new_passwordフィールドを使用してデフォルトの管理者パスワードを新規パスワードに更新する必要があります。デフォルトのパスワードを使用し、new_passwordフィールドに情報を入力せずにログインしようとすると、システムはエラーを返します。

推奨されるパスワードについては、passwardsを参照してください。初回ログインは次のようになります。

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

cURLバージョンは次のようになります。

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

標準ログイン

WhatsApp Business APIクライアントの標準ログインは次のようになります。

POST /v1/users/login
Authorization: Basic base64(username:password)

cURLバージョンは次のようになります。

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

成功すると、200 OKのステータスが、トークンおよびトークンの有効期限とともに返されます。生成されたすべてのトークンの有効期限は7日間です。応答は次の例のようになります。

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

リクエストが失敗すると、HTTPステータスとして401 Unauthorizedが表示されます。このエラーは通常、ログインリクエストで送信されたユーザーネームまたはパスワード、あるいはその両方が無効であり、WhatsApp Business APIクライアントがトークンを生成できないことを意味します。

応答にエラーがある場合は、WhatsApp Enterpriseクライアントのエラーコード と HTTP ステータスコードを参照してください。

返されるフィールド

詳しくはこちら

• ログアウト
• ユーザーの管理
• 管理者パスワードの変更