Tento článek byl vytvořen před více jak 2 roky a může obsahovat zastaralé informace.
Základní informace
- Pro komuninaci s API budete potřebovat login a heslo, které najdete v administraci na Propojení > API.
- API je na adrese:
https://NAZEV-PROJEKTU.admin.ZNACKA-SERVERU.upgates.com/api/v2
. - Každý požadavek, který má v těle JSON, by měl mít hlavičku
Content-Type: application/json
. - V případě chyby vrací API JSON s textem zprávy a odpovídající stavový kód.
- API pracuje v kódování
UTF-8
, tzn. obsah všech požadavků musí být v tomto kódování.
Autentizace
- Musíte si v administraci založit přístup do API.
- Autentizace probíhá pomocí HTTP Basic authentication.
- Každý požadavek musí mít hlavičku
Authorization
. Hodnotou této hlavičky jeBasic
a v base64 zakodovanélogin:heslo
. - Celá hlavička může vypadat např. takto:
Authorization: Basic dGVzdDp0ZXN0
Stavové kódy
200
- úspěšně zpracovaný požadavek.400
- špatný požadavek, nevalidní JSON v těle požadavku, pokud požadavek vyžaduje JSON, musí to být JSON Object.401
- chyba při autentizaci (špatný login nebo heslo, špatná metoda autentizace, chybějící hlavička pro autentizaci).404
- špatná URL adresa požadavku.405
- nepodporovaná metoda API.500
- chyba serveru, pokud nastane kontaktujte technickou podporu UPgates
HTTP metody
Pro přepsání HTTP metody můžete použít hlavičku X-HTTP-Method-Override
. Požadavek může být např. POST, ale v pokud bude v požadavku tato hlavička s hodnotou DELETE, vyhodnotí se jako DELETE.
API podporuje následující HTTP metody:
POST
- vytvořeníPUT
- aktualizaceDELETE
- smazáníGET
- získání dat
Datové typy
Položky které jsou v popisech tučně jsou povinné, datový typ je uveden v závorce u každé položky v popisu jednotlivých API.
bool
- true / false, 1 / 0string
- standardní řetězec znaků v UTF-8int
- celé číslofloat
- desetinné číslo, jako oddělovač desetinných míst používejte tečkuarray
- pole hodnotobject
- JSON Objectemail
- validní emailová adresadate
- datum zapsané jako řeťezec znaků dle ISO 8601language
- kód jazyka dle ISO 639-1currency
- kód měny dle ISO 4217country
- kód země dle ISO 3166-1 alpha-2
Testování
Pro testování API můžete použít:
- Rozšíření Postman pro Google Chrome.
- Rozšíření RESTED pro Mozilla Firefox.
- UPgates API client - náš vlastní jednoduchý API klient v PHP.