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.
/api/integration/get
Získanie jednej integrácie na základe identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor integrácie |
Príklad požiadavky
GET /api/integration/get?id=1
X-API-KEY: {vas_api_kluc}
/api/integration/list
Získanie stránkovaného zoznamu integrácií.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolene: 0) | |
list_condition | object | Objekt filtračných podmienok |
Príklad požiadavky
GET /api/integration/list?list_offset=0
X-API-KEY: {vas_api_kluc}
/api/integration/save
Vytvorenie alebo úprava integrácie. Pre novú integráciu data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nová integrácia, >0 = úprava | |
integration_type_id | int | Identifikátor typu integrácie (napr. e-shop, kuriér) | |
api_name | string | Názov integrácie / interný identifikátor | |
api_url | string | URL koncového bodu API (automaticky sa ukončí znakom /) | |
api_key | string | API kľúč | |
api_token | string | Prístupový token | |
api_token_expire | string | Čas expirácie tokenu | |
api_username | string | Používateľské meno (pri Basic Auth) | |
api_password | string | Heslo (pri Basic Auth) | |
api_client_id | string | OAuth2 client_id | |
api_secret | string | OAuth2 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"
}
}
/api/integration/delete
Odstránenie integrácie na základe identifikátora.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifiká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 } }
Zaregistruj sa teraz,
zaplať neskôr!