Pentru ce este necesar API

API (Application Programming Interface) — este o funcționalitate pentru interacțiunea între diferite programe. Pentru oameni există interfețe separate, de exemplu un site. API este necesar pentru diverse integrări. Sender Solutions are un API care funcționează cu ajutorul cererilor HTTP în formatul JSON. Accesul la API este oferit pentru toate planurile tarifare ale proiectului, inclusiv pe planul tarifar gratuit. Puteți folosi API-ul Sender Solutions pentru o integrare mai completă și mai flexibilă. Formatul prevăzut de folosire a API — de pe site-ul vostru pe baza declanșatoarelor. De exemplu, când pe site-ul vostru se creează un abonat, site-ul execută o cerere API, și un abonat cu date similare se creează în Sender Solutions.

Începutul folosirii API

1. Pentru a folosi API, trebuie să creați un proiect în Contul personal Sender Solutions.
2. În continuare, pe pagina de setări a proiectului, creați o cheie API. Aceasta este o cheie unică de acces la API la nivelul acestui proiect. Păstrați-o în secret. Dacă există suspiciunea că cheia a fost compromisă, începeți cât mai repede să folosiți o cheie nouă, iar cheia compromisă dezactivați-o sau ștergeți-o.
3. Pentru un singur proiect se pot crea mai multe chei API — toate sunt echivalente. Acest lucru poate fi util dacă aveți mai multe aplicații diferite care vor executa cereri API.
4. Cheia API trebuie transmisă în antetul HTTP Authorization.
5. Corpul cererii transmiteți-l în formatul JSON, iar în antetul Content-Type indicați valoarea application/json.
6. Orientați-vă după statusul HTTP al răspunsului. Dacă codul este 200 — totul a decurs cu succes. Dacă codul este 500 — a apărut o eroare.
7. Răspunsul de la API, în general, se returnează în formatul JSON. La nivelul rădăcină este prezentă cheia "success" cu valorile posibile true / false.
   Exemplu de răspuns reușit:
   {
    "success": true
}
   
   Exemplu de răspuns cu eroare:
   {
    "error": "Some error description",
    "success": false
}
   În corpul unui răspuns reușit pot fi date suplimentare în funcție de cererea concretă.
8. Pentru lucrul cu API nu este necesar suportul pentru cookies sau sesiuni.

Resurse utile

Composer pachet pentru lucrul cu API în php: sender-solutions/php-sdk și același pachet pe github: Sender-Solutions/php-sdk

Postman colecția de cereri către API este disponibilă la link