Gestire gli account utente
/v1/users/usernameQuesto documento tratta gli argomenti seguenti:
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 immediatamente.
Solo l'account admin viene utilizzato per gestire gli account, ovvero eseguire azioni come la creazione o la rimozione di utenti. Se dimentichi la password, contatta l'Assistenza diretta per la reimpostazione.
Creare un account utente
L'account admin è l'unico account in grado di creare ed eliminare utenti, quindi come best practice utilizza l'account admin solo a questo scopo. Devi creare account utente e utilizzarli per gestire i client dell'API di WhatsApp Business.
Per creare un account per un utente all'interno dell'azienda che può accedere all'API di WhatsApp Business, invia il nome utente e la password al client dell'API di WhatsApp Business utilizzando l'endpoint users. Convalida il nome utente e la password e crea un nuovo account se non ne esiste già uno per quel nome utente. La password viene elaborata con un hash unidirezionale e archiviata in un volume di dati. username e password sono entrambi parametri obbligatori.
Richiesta
Per creare un utente, invia una richiesta come quella mostrata nell'esempio seguente:
POST /v1/users
Authorization: Bearer your-auth-token
{
"username": "username",
"password": "password"
}
Parametri
| Nome | Obbligatorio | Descrizione |
|---|---|---|
| Sì | Deve contenere almeno 4 caratteri e massimo 32 caratteri. |
| Sì | Deve contenere almeno 8 caratteri e massimo 64 caratteri. |
| Sì | Token di autenticazione per l'amministratore che sta eseguendo la richiesta. Consulta la documentazione Accesso e autenticazione - Token per ulteriori informazioni. |
Risposta
Se la richiesta ha esito positivo e viene creato un account utente, riceverai un codice di stato HTTP di 201 Created e il seguente payload:
{
"users": [{
"username": "username"
}]
}
Se la richiesta non ha esito positivo, riceverai un codice di stato HTTP, insieme a un codice di errore WhatsApp. Se invii un nome utente duplicato, la risposta all'errore sarà simile a questa:
{
"errors": [{
"code": 1014,
"title": "Internal error",
"details": "Unable to create user. Already exist?"
}]
}
Alcuni errori probabili:
| Codice di stato HTTP | Motivo |
|---|---|
|
Invia di nuovo la richiesta con un nome utente/una password di lunghezza appropriata. |
| Non stai usando l'account |
| Impossibile creare l'account, probabilmente perché esiste già. |
Se vi sono altri errori nella risposta, consulta le fonti seguenti per ulteriori informazioni:
Modificare una password utente
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 immediatamente. Consulta la documentazione Accesso e autenticazione per ulteriori informazioni sul primo accesso.
Un utente con il ruolo di ROLE_ADMIN può aggiornare la password associata agli account utente con ruoli di ROLE_ADMIN e ROLE_USER. Anche i singoli utenti possono aggiornare la password per i propri account. L'aggiornamento della password di un account utente non invalida alcun token di accesso associato all'utente. Attualmente, solo l'utente admin ha ROLE_ADMIN; altri utenti hanno ROLE_USER.
Richiesta
Per aggiornare la password per un account, fornisci il Bearer token insieme al nome utente e alla nuova password.
PUT /v1/users/username
Authorization: Bearer your-auth-token
{
"password": "new-password"
}
Risposta
In caso di azione eseguita correttamente, la password associata al nome utente viene aggiornata. Viene restituito il codice di stato HTTP 200 OK, insieme a un payload simile al seguente:
{
"users": [{
"username": "username"
}]
}
In caso contrario, la risposta potrebbe contenere uno dei seguenti codici di errore:
| Codice di stato HTTP | Motivo |
|---|---|
| Richiesta non valida |
| Impossibile convalidare le credenziali |
| L'account non esiste |
| Motivo sconosciuto |
Recuperare un account utente
Puoi ottenere informazioni per determinare se un account utente è stato creato per un nome utente specifico e per scoprire il ruolo assegnato all'account utente.
Richiesta
Per recuperare un account utente, usa una richiesta GET sull'endpoint users.
GET /v1/users/username Authorization: Bearer your-auth-token
Risposta
In caso di azione eseguita correttamente, la risposta sarà il codice di stato HTTP 200 OK e un payload simile al seguente:
{
"users": [{
"ROLES": "ROLE_ADMIN | ROLE_USER",
"username": "username"
}]
}
In caso contrario, la risposta potrebbe contenere uno dei seguenti codici di errore:
| Codice di stato HTTP | Motivo |
|---|---|
| Il |
| Non è stato trovato alcun account utente con il nome utente inviato nella richiesta. |
| Motivo sconosciuto |
Eliminare un account utente
Se un account è compromesso o se ci sono altri motivi per eliminarlo, l'admin deve eliminare l'account. Dopo aver eliminato correttamente un account, tutti i token associati all'account vengono rimossi dal sistema.
L'account admin non può essere rimosso dal sistema.
Richiesta
Usa la seguente chiamata API per eliminare un account utente, dove username è il nome dell'account utente che desideri eliminare. Il Bearer token è il token appartenente all'account admin.
DELETE /v1/users/username Authorization: Bearer your-auth-token
Risposta
In caso di azione eseguita correttamente, l'account utente viene eliminato. La risposta include il codice di stato HTTP 200 OK e il seguente payload:
{
"users": [{
"username": "username"
}]
}
In caso contrario, la risposta potrebbe contenere uno dei seguenti codici di errore:
| Codice di stato HTTP | Motivo |
|---|---|
| Nome utente non valido, |
| Impossibile convalidare le credenziali |
| Non si sta usando l'account |
| L'account non esiste |
| Motivo sconosciuto |