Passa al contenuto principale

Crea una chiave API

POST 
/api/partner-gateway/v1/authentication

Crea una nuova chiave API per il tuo account e restituisce il valore completo della chiave nella risposta. IMPORTANTE: il valore completo della chiave viene mostrato una sola volta in questa risposta. Non può essere recuperato di nuovo tramite alcun endpoint, quindi devi copiarlo e conservarlo in modo sicuro subito dopo la creazione. La chiave diventa attiva istantaneamente e può essere usata per autenticare le richieste passandola nell'header X-API-Key. Devi limitare l'ambito della chiave elencando le operazioni (es. SMS, RCS, WHATSAPP) nel campo operations del corpo della richiesta, in modo che ogni integrazione ottenga una chiave con privilegi minimi. Le operazioni che richiedi devono essere un sottoinsieme delle operazioni possedute dalla chiave che effettua questa chiamata: una chiave non può concedere privilegi che non ha essa stessa. Usa GET /authentication/me per verificare a quali operazioni è limitata la tua chiave attuale prima di sceglierle. Se perdi una chiave, l'unica opzione è eliminarla con DELETE /authentication/{id} e crearne una nuova. Le chiavi create qui sono identificate dal loro id e userId e non hanno uno username, quindi il campo username della risposta è sempre null. Restituisce 400 se il corpo della richiesta è malformato o mancano campi obbligatori, inclusa una lista operations assente o vuota. Restituisce 403 se le operazioni richieste superano l'ambito della chiave che effettua la chiamata. Restituisce 500 in caso di errore interno.

Richiesta​

Risposte​

Chiave API creata con successo

Ultimo aggiornamento il