Základní informace

  • pro komuninaci s API budete potřebovat login a heslo který najdete v administraci na
    Nastavení > Import / Export > Ostatní
  • API je na adrese: https://NAZEV-PROJEKTU.admin.SERVER.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í 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

  • autentizace probíhá pomocí HTTP Basic authentication
  • každý požadavek musí mít hlavičku Authorization, hodnotou této hlavičky je Basic 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 prosím technickou podporu UPgates podpora@upgates.cz

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 - aktualizace
  • DELETE - smazání
  • GET - získání dat

Datové typy

  • položky které jsou v popisech tučně jsou povinné
  • bool - true / false, 1 / 0
  • string - standardní řetězec znaků v UTF-8
  • int - celé číslo
  • float - desetinné číslo, jako oddělovač desetinných míst používejte tečku
  • array - pole hodnot
  • object - JSON Object
  • email - validní emailová adresa
  • date - datum zapsané jako řeťezec znaků dle ISO 8601
  • language - kód jazyka dle ISO 639-1
  • currency - kód měny dle ISO 4217
  • country - kód země dle ISO 3166-1 alpha-2

Testování

Pro testování API můžete použít např. rozšíření do prohlížeče: