API Key

Crea e gestisci le chiavi API che autenticano le richieste a questa API.

📄️Cerca chiavi API

Restituisce tutte le chiavi API associate al tuo account. Ogni voce include l'ID della chiave, lo username associato, le operazioni consentite, il tipo di traffico e la data di creazione, ma il valore completo della chiave non viene restituito per motivi di sicurezza. Facoltativamente, filtra la lista per userId per vedere solo le chiavi create da un utente specifico o assegnate a esso. Usa questo endpoint per verificare quali chiavi esistono prima di crearne di nuove o di revocare quelle vecchie. Per esaminare la chiave che sta autenticando la tua richiesta, incluse le operazioni a cui è limitata, usa invece GET /authentication/me. Restituisce 500 in caso di errore interno.

📄️Crea una chiave API

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.

📄️Descrivi la chiave API corrente

Restituisce i metadati della chiave API che ha autenticato questa richiesta: il suo ID, l'azienda, l'utente, lo username, le operazioni consentite, il tipo di traffico e la data di creazione. Usalo per verificare che una chiave che hai memorizzato sia ancora valida e per controllare per quali operazioni è autorizzata. La chiave viene identificata dall'header X-API-Key, quindi non viene mai inviata nell'URL — questo endpoint non accetta parametri. Il valore della chiave non fa parte della risposta e rimane non disponibile dopo la creazione, come documentato su POST /authentication. Restituisce 401 se l'header X-API-Key è mancante, sconosciuto o non autorizzato per l'operazione AUTHENTICATION. Restituisce 500 in caso di errore interno.

📄️Elimina una chiave API

Revoca ed elimina definitivamente una chiave API. La revoca ha effetto immediato: qualsiasi richiesta API successiva che usa la chiave eliminata nell'header X-API-Key riceverà una risposta 401 Non autorizzato. Questa azione non può essere annullata. Se elimini una chiave per errore, devi crearne una nuova con POST /authentication e aggiornare tutti i client che usavano la vecchia chiave. Prima di eliminarla, assicurati che nessuna integrazione attiva o job programmato dipenda da questa chiave, per evitare interruzioni del servizio. Restituisce 204 in caso di successo, senza corpo di risposta. Restituisce 404 se non esiste alcuna chiave con l'ID specificato o se non appartiene al tuo account. Restituisce 500 in caso di errore interno.