Înregistrare Autentificare

API Webhook

Gestionarea mesajelor webhook ieșite — preluarea notificărilor de evenimente de integrare și gestionarea stării acestora

Puncte finale

Autentificare

Fiecare cerere API necesită trimiterea header-ului X-API-KEY.

X-API-KEY: {cheia_dvs_api}

Mai ai întrebări?

Trimite-ne un tichet, sau caută în motorul nostru de căutare.

Dacă ți-a plăcut, distribuie-l și altora

URL de bază

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

Fiecare cerere returnează un răspuns JSON. În caz de succes, result.code == 1, în caz de eroare, result.code == 0. Înregistrările webhook stochează notificările de evenimente trimise către integrare (de ex. comandă nouă, emitere factură). Câmpul sended indică dacă webhook-ul a fost deja trimis.

GET /api/integration_webhook/get

Preluarea unei singure înregistrări webhook pe baza identificatorului.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul înregistrării webhook

Exemplu de cerere

GET /api/integration_webhook/get?id=200
X-API-KEY: {cheia_dvs_api}
GET /api/integration_webhook/list

Preluarea listei paginate a înregistrărilor webhook.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_conditionobjectObiect cu condiții de filtrare

Exemplu de cerere

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

Creare sau modificare a unei înregistrări webhook. La modificare se poate actualiza doar câmpul sended. Pentru o înregistrare nouă, data[id] = 0.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idint0 = înregistrare nouă, >0 = modificare (actualizare sended)
integration_idintIdentificatorul integrării
integration_webhook_type_idintTipul evenimentului webhook
receipt_idintIdentificatorul documentului asociat
receipt_type_idintTipul documentului
product_idintIdentificatorul produsului asociat
requeststringConținutul cererii trimise (JSON)
request_urlstringURL-ul cererii
responsestringConținutul răspunsului primit
sendedint1 = trimis (la modificare)

Exemplu de cerere

POST /api/integration_webhook/save
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "integration_id": 1,
    "integration_webhook_type_id": 3,
    "receipt_id": 150,
    "receipt_type_id": 2
  }
}
POST /api/integration_webhook/delete

Ștergerea unei înregistrări webhook pe baza identificatorului.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idintIdentificatorul webhook-ului care urmează să fie șters

Exemplu de cerere

POST /api/integration_webhook/delete
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "id": 200 } }
POST /api/integration_webhook/close

Închiderea unei înregistrări webhook — marcare ca trimis și înregistrarea datelor de răspuns.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idintIdentificatorul webhook-ului care urmează să fie închis
responsestringConținutul răspunsului primit
response_http_codestringCodul de stare HTTP

Exemplu de cerere

POST /api/integration_webhook/close
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "id": 200, "response_http_code": "200" } }

Ia legătura cu noi

Ești interesat de software-ul nostru? Scrie-ne cu încredere!

Trimite o solicitare

Ai nevoie de ajutor?

Dacă nu găsești răspunsul și ai nevoie de asistență

Răsfoiește centrul de ajutor

Creează-ți contul acum,
plătește mai târziu!

Încearcă gratuit timp de 3 zile, fără riscuri și fără obligații!
Creare cont
Înregistrare