Accesso

/v1/users/login

Per effettuare l'autenticazione con il client dell'API di WhatsApp Business, devi effettuare l'accesso. Per accedere, devi inviare il nome utente e la password tramite l'autenticazione di base per ricevere un bearer token in risposta. Quindi potrai utilizzare il bearer token per l'autenticazione durante l'invio di richieste a qualsiasi endpoint dell'API di WhatsApp Business. Scopri di più sull'autenticazione per usare l'API.

Prima di iniziare

Il client dell'API di WhatsApp Business ha un account predefinito: il nome utente dell'account è admin e la password è secret. Questo account non può essere rimosso o eliminato dal sistema. Per motivi di sicurezza, devi modificare la password dell'amministratore al primo accesso.

Consigli sulle password

Ti consigliamo di utilizzare password complesse durante la creazione di nuovi account e l'impostazione delle relative password, come da best practice del settore.

Le password devono avere una lunghezza compresa tra 8 e 64 caratteri e devono contenere almeno:

  • Una cifra
  • Un carattere maiuscolo
  • Un carattere minuscolo
  • Un carattere speciale tra !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

La complessità della password viene applicata alla creazione di un nuovo account o alla modifica della password di un account esistente.

Creazione

Effettua l'autenticazione utilizzando l'autenticazione di base (nome utente, password) durante l'accesso. L'Authorization è impostata nell'intestazione HTTP. Il type è Basic e le credentials corrispondono a una stringa con codifica base64 costituita da username e password uniti da due punti (ovvero, username:password).

Quando la richiesta di accesso viene ricevuta dal client dell'API di WhatsApp Business, le credenziali vengono elaborate per la convalida.

  • Se l'operazione va a buon fine, viene generato il token. La risposta contiene il token nel campo token.
  • Se l'operazione non va a buon fine, viene restituito un errore.

Esempi

Primo accesso

Per motivi di sicurezza, devi aggiornare la password dell'amministratore predefinita con una nuova password utilizzando il campo new_password al primo accesso. Se tenti di accedere con la password predefinita senza informazioni nel campo new_password, il sistema restituisce un errore.

Consulta password per i nostri consigli. Il primo accesso dovrebbe essere simile a:

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

La versione cURL è simile a:

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"}'

Accesso standard

L'accesso standard per il client dell'API di WhatsApp Business è simile a:

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

La versione cURL è simile a:

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

Se l'operazione va a buon fine, viene restituito lo stato 200 OK, insieme al token e alla relativa scadenza. Tutti i token generati scadono in 7 giorni. La risposta è simile all'esempio seguente:

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

Se la richiesta non viene eseguita correttamente, lo stato HTTP visualizzato è 401 Unauthorized. In genere, questo errore indica che il nome utente e/o la password inviati con la richiesta di accesso non sono validi e pertanto il client dell'API di WhatsApp Business non è in grado di generare il token.

Se la risposta contiene degli errori, consulta le seguenti sezioni per maggiori informazioni: Codici di errore del client WhatsApp Enterprise e Codici di stato HTTP.

Campi restituiti

Campo Descrizione

token

Obbligatorio.

Token di autenticazione da utilizzare per tutte le altre chiamate all'API di WhatsApp Business. Il token deve essere inviato nell'intestazione di autorizzazione nel formato:
Authorization: Bearer <authentication-token>

expires_after

Obbligatorio.

Data e ora di scadenza del token. Per impostazione predefinita, corrisponde a 7 giorni.