Katalog spletnih servisov
Katalog spletnih servisov je skupno mesto, kjer se nahaja dokumentacija API.
Na tem spletnem mestu lahko berete, kopirate in testirate različne metode ter jih prilagajate svojim potrebam.
Kazalo
- Glava
- Parametri
- Odgovori
- Sheme
|
1. Glava
Glava posameznega primera API PANTHEON vsebuje informacije o tem, kateri način delovanja se uporablja, končno točko API glede na osnovni URL, opis prikazanega dejanja in delovni primer poizvedbe:
- Uporabljene metode delovanja
- Končna točka
- Opis
- Primer poizvedbe
Metode delovanja v PANTHEON API:
|
|
Pridobi podatke iz strežnika.
|
|
|
Ustvari nove zapise v bazi podatkov ali pridobi podatke iz strežnika.
|
|
|
Posodablja obstoječe zapise.
|
2. Parametri
V Parametrih je prikazan primer poizvedbe brez prikazanih vrednosti.
S klikom na gumb Preizkusite se odpre urejevalnik poizvedb in lahko pripravite svoje poizvedbe.
Ko so podatki ali poizvedba vneseni, lahko izvedete metodo z izbiro gumba Execute. Če želite zapreti urejevalnik, izberite gumb Cancel.
2.1 Polje parametrov
V nekaterih API-jih je mogoče podatke vnesti tudi v polje Parameters:
2.1.1 Input field
V polju Parameters Ident, lahko vnesete svoj ident.
2.1.2 Telo zahteve
V telo zahteve lahko vnesete svojo poizvedbo ali uredite vzorčno poizvedbo.
3. Odgovori
V Odgovorih so rezultati prikazani po izvedbi poizvedbe.
Odgovori vključujejo:
- cURL
- URL zahteve
- Odgovor strežnika
3.1 cURL
Vsebuje orodje ukazne vrstice cURL s parametri izvedene poizvedbe. Z ikono za kopiranje v odložišče v desnem spodnjem kotu lahko preprosto kopirate vrstico cURL v odložišče.
3.2 URL zahteve
Vsebuje URL, ki ga je uporabila metoda. Sestavljen je iz metode HTTPS, osnovnega URL-ja in URI-ja končne točke ali vira.
3.3 Odgovor strežnika
Prikaže rezultate uspešno izvedene poizvedbe.
Glave odgovora vsebujejo informacije o vrsti vsebine, naboru znakov, času in strežniku izvedene poizvedbe.
V telesu odgovora so rezultati predstavljeni v formatu JSON. Lahko jih kopirate v odložišče ali prenesete kot datoteko .json, tako da izberete ustrezen gumb v spodnjem desnem kotu.
Kode, prikazane v odgovorih, prikazujejo stanje izvedene poizvedbe.
|
200
|
Success: successfully executed.
|
|
500
|
Error: description of an error.
|
4. Sheme
Sheme vsebujejo informacije o strukturi podatkov objektov.
Specifična shema nudi opis podanega predmeta.
