Az API-hoz REST protokoll által definiált módon lehet csatlakozni. Az adatformátum JSON alapú. Az API HTTP a GET,POST,PUT és DELETE metódusait használja.
Authentikáció
Minden API hívásnál szükséges megadni a felhasználónevet és jelszót, vagyis az API kulcspárt. Az API kétféle authentikációt használ: HTTP Basic (például cURL-el való kapcsolódáshoz) és a Digest típusút (például .NET alkalmazásokból való meghívás esetén). A kettő közül bármelyik használható, az API automatikusan felismeri a megfelelőt.
A HTTP Basic Authentication használatakor javasolt a felhasználónevet és a jelszót a HTTP Authorization fejlécben átadni. Bár egyes HTTP kliensek támogatják az authentikációs adatok URL-ben történő átadását is, kompatibilitási és biztonsági okokból a fejléc használata az ajánlott megoldás.
Ajánlott megoldás: Authorization header
Authorization: Basic base64_encode($username . ':' . $password)
Alternatív megoldás: HTTP Basic Authentication az URL-ben
https://<username>:<password>@api.salesautopilot.com/subscribe/<nl_id>/form/<ns_id>
Alternatív megoldás: HTTP Basic Authentication a fejlécben (cURL használatával)
curl_setopt($ch,CURLOPT_USERPWD,"username:letk4yewt52dszh8odkke3c5");
Adatcsere formátum
Jelenleg a JSON adatformátumot támogatja az API mind a bemenő, mind a kimenő adatok tekintetében. Fontos, hogy az átadott adatok megfeleljenek a JSON szabványnak és megfelelően legyenek kódolva. A Query string-ben átadott adatokat URL encode-olni kell.
Karakterkódolás
Az API minden adatkommunikációjában UTF-8 karakterkódolást használ.
Válaszban szereplő állapotkódok
Az API által adott válaszban mindig szerepel egy HTTP státuszkód amely jelzi az API hívás sikerességét vagy sikertelenségét. A következő válaszkódok lehetségesek:
200 : sikeres API hívás
401: az authentikáció nem sikerült, hibás felhasználónév vagy jelszó
404 : ismeretlen erőforrás
405 : hibás metódus
406 : hibás paraméterek
500 : nem kezelt hiba történt, vegye fel a kapcsolatot az ügyfélszolgálattal