Základné informácie

  • pre komuninaci s API budete potrebovať login a heslo ktorý nájdete v administrácii na
    Nastavenie / Import / Export /Ostatné 
  • API je na adrese: https://NAZEV-PROJEKTU.admin.SERVER.upgates.com/api/v2
  • každú požiadavku ktorý má v tele JSON, by mal mať hlavičku Content-Type: application / json
  • v prípade chyby vracia JSON s textom správy a zodpovedajúci kód stavu
  • API pracuje v kódovaní UTF-8 , tzn. obsah všetkých požiadaviek musia byť v tomto kódovaní

Autentizácia

  • autentizácia prebieha pomocou HTTP Basic authentication
  • každú požiadavku musí mať hlavičku Authorization , hodnotou tejto hlavičky je Basic a v base64 zakódované login: heslo
  • celá hlavička môže vyzerať napr. Takto: Authorization: Basic dGVzdDp0ZXN0

Stavové kódy

  • 200 úspešne spracovaný požiadavku
  • 400 zlý požiadavku, nevalidný JSON v tele požiadavky ak požiadavka vyžaduje JSON, musí to byť JSON Object
  • 401 chyba pri autentizácii (zlý login alebo heslo, zlá metóda autentizácia, chýbajúce hlavička pre autentizáciu)
  • 404 zlá URL adresa požiadavke
  • 405 nepodporované metóda API
  • 500 chyba servera, pokiaľ nastane kontaktujte prosím technickú podporu UPgates podpora@upgates.sk

HTTP metódy

Pre prepísanie HTTP metódy môžete použiť hlavičku X-HTTP-Method-Override . Požiadavka môže byť napr. POST, ale v ak bude v požiadavke táto hlavička s hodnotou DELETE, vyhodnotí sa ako DELETE.
API podporuje nasledujúce HTTP metódy:

  • POST - vytvorenie
  • PUT - aktualizácie
  • DELETE - zmazanie
  • GET - získanie dát

Dátové typy

  • položky ktoré sú v popisoch tučne sú povinné
  • bool - true / false, 1/0
  • string - štandardné reťazec znakov v UTF-8
  • int - celé číslo
  • float - desatinné číslo, ako oddeľovač desatinných miest používajte bodku
  • array - pole hodnôt
  • object - JSON Object
  • email - validný emailová adresa
  • date - dátum zapísané ako reťazec znakov podľa ISO 8601
  • language - kód jazyka podľa ISO 639-1
  • currency - kód meny podľa ISO 4217
  • country - kód krajiny podľa ISO 3166-1 alpha-2

Testovanie

Pre testovanie API môžete použiť napr. Rozšírenie do prehliadača: