Definizione
Un’API REST è un’interfaccia web che espone risorse, come messaggi, contatti o template, tramite URL e permette ai programmi di crearle, leggerle, aggiornarle ed eliminarle con i metodi HTTP standard (POST, GET, PATCH, DELETE), di solito scambiando JSON.
REST (representational state transfer) è uno stile architetturale descritto da Roy Fielding nel 2000. In pratica, un’API REST di messaggistica significa inviare una richiesta HTTPS autenticata, ad esempio POST /messages con un corpo JSON, e ricevere una risposta JSON con un ID e uno stato. I codici di stato HTTP segnalano l’esito: 2xx successo, 4xx errori del client come numeri non validi o autorizzazione mancante, 5xx errori del server.
Schemi tipici: autenticazione con token Bearer nell’intestazione Authorization, chiavi di idempotenza perché i nuovi tentativi non inviino duplicati, paginazione per gli elenchi, limiti di frequenza con intestazioni retry-after e webhook per i risultati asincroni come i rapporti di consegna.
REST si adatta alla maggior parte delle integrazioni: CRM, piattaforme e-commerce e sistemi di back-office. Per volumi SMS molto elevati, operatori e aggregatori usano spesso invece SMPP, che mantiene aperta una connessione persistente.
Una specifica OpenAPI descrive gli endpoint in modo leggibile dalle macchine, così SDK client, documentazione e test possono essere generati da essa.
OmniChannels.ai offre un’API REST/JSON su https://api.broadnet.me con autenticazione tramite token Bearer, una specifica OpenAPI 3.1 e un SDK TypeScript.
Esempio
POST https://api.broadnet.me/… con l’intestazione "Authorization: Bearer <token>" e un corpo JSON; la risposta restituisce un ID messaggio.