Catalogul Serviciilor Web
Catalogul Serviciilor Web este un loc comun unde se află documentația API.
În acest cadru, puteți citi, copia și testa diverse metode și să le adaptați nevoilor dumneavoastră.
Cuprins
- Antet
- Parametri
- Răspunsuri
- Scheme
|
1. Antet
Antetul unui exemplu individual de API PANTHEON conține informații despre metoda de operare utilizată, punctul final API relativ la URL-ul de bază, descrierea unei acțiuni afișate și un exemplu funcțional de interogare:
- Metode de operare utilizate
- Punct final
- Descriere
- Exemplu de interogare
Metode de operare în API-ul PANTHEON:
|
|
Recuperează date de pe server.
|
|
|
Creează noi înregistrări în baza de date sau recuperează date de pe server.
|
|
|
Actualizează înregistrările existente.
|
2. Parametri
În Parametri, este afișat un exemplu de interogare fără valori.
Prin apăsarea butonului Încearcă , editorul de interogări se deschide și puteți pregăti propriile interogări.
După ce datele sau interogarea sunt introduse, puteți executa metoda selectând butonul Execută . Dacă doriți să ieșiți din editor, selectați butonul Anulează .
2.1 Câmpul Parametri
În unele API-uri, datele pot fi introduse și în câmpul Parametri :
2.1.1 Câmp de introducere
În câmpul Parametri Ident, puteți introduce elementul dumneavoastră.
2.1.2 Corpul cererii
În corpul cererii, puteți introduce interogarea dumneavoastră sau edita interogarea exemplu.
3. Răspunsuri
În Răspunsuri, rezultatele sunt afișate după ce interogarea este executată.
Răspunsurile includ:
- cURL
- URL-ul cererii
- Răspunsul serverului
3.1 cURL
Conține un instrument de linie de comandă cURL cu parametrii interogării executate. Cu pictograma de copiere în clipboard din colțul din dreapta jos, puteți copia cu ușurință linia cURL în clipboard.
3.2 URL-ul cererii
Conține URL-ul utilizat de metodă. Acesta constă dintr-o metodă HTTPS, un URL de bază și un punct final sau URI de resursă.
3.3 Răspunsul serverului
Afișează rezultatele unei interogări executate cu succes.
Anteturile răspunsului conțin informații despre tipul de conținut, setul de caractere, timpul și serverul interogării executate.
În corpul răspunsului, rezultatele sunt prezentate în format JSON. Acestea pot fi copiate în clipboard sau descărcate ca fișier .json selectând butonul corespunzător din colțul din dreapta jos.
Codurile afișate în Răspunsuri arată starea interogării executate.
|
200
|
Succes: executat cu succes.
|
|
500
|
Eroare: descrierea unei erori.
|
4. Scheme
Schemele conțin informații despre structura datelor obiectelor.
O schemă specifică oferă o descriere a obiectului specificat.
