Exemplu de server api pentru a dezvolta aplicații client - împăciuitor - uri de software

terminologie

Server, server-side - un set de script-uri și baze de date care rulează pe serviciul de server. Backend.

Partea de client, o aplicație client - orice aplicație terță parte (în acest caz, se referă la o aplicație mobilă), care interacționează cu serviciul de date prin REST API prin trimiterea de solicitări la partea de server și obținerea de rezultate de la ea.

Versiune API REST 1.0 Restricții

Pentru a accelera procesul de dezvoltare a serverului va fi utilizat:

● protocolul HTTP. Următoarea versiune este planificată pentru a utiliza HTTPS (trebuie să cumpere certificat)

● Este de transmisie Numele metodei ca parametru, mai degrabă decât o parte din drum. utilizarea ambelor variante sunt planificate în versiunea următoare.

● Tip de solicitare - GET. Următoarea versiune - GET si POST.

● Afișează rezultatele în format JSON.

● utilizând datele de conectare și parola de autentificare a utilizatorului. Următoarea versiune - OAuth 2.0.

Cum să utilizați API-ul REST

API-ul REST definește un set de metode pentru care aplicațiile externe pot face cereri și să primească răspunsuri.

Pentru a apela o metodă API, trebuie să pună în aplicare cererea GET la protocolul HTTP.

● Versiune API - v1.

● Numele metodei - din următoarea listă de metode.

● Parametri Metoda - parametrii API metoda corespunzătoare.

● parametrii de interogare necesare - vor fi discutate mai jos.

Ca răspuns la cererea de aplicare devine rezultatul în format JSON. rezultat Codificare - UTF-8.

În cazul în care cererea reușește, conținutul rezultatul este afișat în rezultatul cheie. Dacă interogarea eșuează, codul de eroare și textul sunt afișate într-o eroare de cheie.

Comună pentru toate codurile și textele metode de eroare