Integration API

Manage external system integrations — retrieval, creation, update, and deletion

Base URL

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

Every request returns a JSON response. On success result.code == 1, on error result.code == 0. An integration stores the connection to an external system (webshop, courier service, accounting software, etc.) — with API keys, URLs, and identifiers.

GET /api/integration/get

Retrieve a single integration by identifier.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the integration

Example request

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

Retrieve a paginated list of integrations.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object

Example request

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

Create or update an integration. For a new integration use data[id] = 0.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new integration, >0 = update
integration_type_idintIntegration type identifier (e.g. webshop, courier)
api_namestringIntegration name / internal identifier
api_urlstringAPI endpoint URL (automatically terminated with a / character)
api_keystringAPI key
api_tokenstringAccess token
api_token_expirestringToken expiration date/time
api_usernamestringUsername (for Basic Auth)
api_passwordstringPassword (for Basic Auth)
api_client_idstringOAuth2 client_id
api_secretstringOAuth2 client_secret

Example request

POST /api/integration/save
X-API-KEY: {your_api_key}
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

Delete an integration by identifier.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the integration to delete

Example request

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

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

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!