A cosa serve l'API

API (Application Programming Interface) — è una funzionalità per l'interazione tra diversi programmi. Per le persone esistono interfacce separate, ad esempio un sito. L'API serve per varie integrazioni. Sender Solutions ha un'API che funziona mediante richieste HTTP in formato JSON. L'accesso all'API è fornito per tutti i piani tariffari del progetto, incluso il piano tariffario gratuito. Puoi usare l'API di Sender Solutions per un'integrazione più completa e flessibile. Il formato previsto di utilizzo dell'API — dal tuo sito sulla base di trigger. Ad esempio, quando sul tuo sito viene creato un iscritto, il sito esegue una richiesta API, e un iscritto con gli stessi dati viene creato in Sender Solutions.

Inizio dell'uso dell'API

1. Per usare l'API, devi creare un progetto nell'Account personale di Sender Solutions.
2. Successivamente, nella pagina delle impostazioni del progetto, crea una chiave API. È una chiave di accesso univoca all'API a livello di questo progetto. Conservala in segreto. Se c'è il sospetto che la chiave sia stata compromessa, inizia a usare una nuova chiave il prima possibile, e disattiva o elimina la chiave compromessa.
3. Per uno stesso progetto si possono creare più chiavi API — sono tutte equivalenti. Ciò può essere utile se hai più applicazioni diverse che eseguiranno richieste API.
4. La chiave API deve essere trasmessa nell'intestazione HTTP Authorization.
5. Trasmetti il corpo della richiesta in formato JSON, e nell'intestazione Content-Type indica il valore application/json.
6. Orientati sullo stato HTTP della risposta. Se il codice è 200 — è andato tutto a buon fine. Se il codice è 500 — si è verificato un errore.
7. La risposta dell'API in genere viene restituita in formato JSON. A livello radice è presente la chiave "success" con i valori possibili true / false.
   Esempio di risposta riuscita:
   {
    "success": true
}
   
   Esempio di risposta con errore:
   {
    "error": "Some error description",
    "success": false
}
   Nel corpo di una risposta riuscita possono esserci dati aggiuntivi a seconda della richiesta specifica.
8. Per lavorare con l'API non è necessario il supporto di cookie o sessioni.

Risorse utili

Composer pacchetto per lavorare con l'API in php: sender-solutions/php-sdk e lo stesso pacchetto su github: Sender-Solutions/php-sdk

Postman la collezione di richieste all'API è disponibile al link