API integrácií

Správa integrácií s externými systémami — získavanie, vytváranie, úprava a odstraňovanie

Základná URL

https://{tenant}.logzi.com/api/integration/

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Integrácia ukladá prepojenie s externým systémom (e-shop, kuriérska služba, účtovný softvér atď.) — pomocou API kľúčov, URL adries a identifikátorov.

GET /api/integration/get

Získanie jednej integrácie na základe identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor integrácie

Príklad požiadavky

GET /api/integration/get?id=1
X-API-KEY: {vas_api_kluc}
GET /api/integration/list

Získanie stránkovaného zoznamu integrácií.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolene: 0)
list_conditionobjectObjekt filtračných podmienok

Príklad požiadavky

GET /api/integration/list?list_offset=0
X-API-KEY: {vas_api_kluc}
POST /api/integration/save

Vytvorenie alebo úprava integrácie. Pre novú integráciu data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová integrácia, >0 = úprava
integration_type_idintIdentifikátor typu integrácie (napr. e-shop, kuriér)
api_namestringNázov integrácie / interný identifikátor
api_urlstringURL koncového bodu API (automaticky sa ukončí znakom /)
api_keystringAPI kľúč
api_tokenstringPrístupový token
api_token_expirestringČas expirácie tokenu
api_usernamestringPoužívateľské meno (pri Basic Auth)
api_passwordstringHeslo (pri Basic Auth)
api_client_idstringOAuth2 client_id
api_secretstringOAuth2 client_secret

Príklad požiadavky

POST /api/integration/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "integration_type_id": 1,
    "api_name": "Webshop kapcsolat",
    "api_url": "https://webshop.example.com/api/",
    "api_key": "myapikey123"
  }
}
POST /api/integration/delete

Odstránenie integrácie na základe identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor integrácie, ktorá sa má odstrániť

Príklad požiadavky

POST /api/integration/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 1 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!