Descriere modul API REST

Platforma Accolades permite aplicațiilor externe să transmită comenzi către server cu ajutorul cererilor de tip HTTP. Acest API este realizat pe principiile REST, cu mici particularități generate de structura aplicației.

Inițializare cerere

O comandă către API se realizează printr-o cerere HTTPS către serverul de telefonie Accolades, folosind portul standard pentru https: 443.

Întregul URL al cererii este de forma:

https://client.voipit.ro/<numarCont>/<caleCerere>/

unde:

numarCont

Numărul de cont pentru care se realizează cererea (disponibil în fișa contului, tabul Identitate).

caleCerere

Calea căte cererea care se rulează (așa cum este indicată în documentație).

Parametrii

Toți parametrii necesari procesării se transmit prin POST. Nu se procesează parametrii de tip GET. Parametrii se vor coda folosind standarul URL encoding (percent-encoding).

Orice cerere va conține, întotdeauna, parola pentru autentificarea în API, transmisă ca parametru POST, cu denumirea password. Parola se definește în tabul API din fișa contului.

Răspuns server

Atunci când se primește răspunsul de la server, trebuie să verificați întotdeauna statusul cererii http. În funcție de rezultatul procesării cererii, serverul Accolades răspunde cu statusul 200 pentru cererile procesate cu succes sau cu o altă valoare, în cazul în care a aparut o eroare. O listă a codurilor de eroare este prezentată în subcapitolul "Coduri eroare".

Pentru cererile procesate corect serverul Accolades va intoarce întotdeauna răspunsul la cerere în format JSON. Se va transmite inclusiv un header "content-type: application/json".

Jurnal erori

Atunci când apar erori în procesarea cererilor, Accolades va înregistra acest eveniment în jurnalul contului, disponibil în tabul Jurnal din fișa contului.

Testare conexiune

Înaintea implementarii unor operații complexe, puteți testa conexiunea și răspunsul transmis de server folosind o cerere de tip PING (vezi descrierea acestui tip de pachet din pagina dedicată).

Blocare IP

Serverul Accolades permite, de la un singur IP, un număr limitat de cereri de autentificare incorecte sau de cereri către pagini sau comenzi inexistente. Dacă depașiți aceasta limită, serverul va respinge, pentru o anumită perioadă de timp orice alta cerere și va întoarce statusul http 403 - Forbidden.

IP-ul se poate debloca din meniul aplicației, prin selectarea opțiunii Server și apoi a sectiunii IP monitorizate. Deoarece Accolades este un serviciu de tip cloud, deblocarea înainte de expirarea termenului se poate realiza doar prin contactarea VoIPIT.