Înregistrare Autentificare

API Reguli de document

Gestionarea regulilor de automatizare — conversie documente, gestiune stoc și trimitere webhook

Endpoint-uri

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/receipt_rule/

Fiecare cerere returnează un răspuns JSON. În caz de succes result.code == 1, în caz de eroare result.code == 0. Regula de document descrie o logică de automatizare — de ex. conversie comandă → aviz de expediție, execuție mișcare de stoc, trimitere webhook sau tipărire. Regulile pot fi rulate manual sau programat.

GET /api/receipt_rule/get

Preluarea unei singure reguli pe baza identificatorului.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul regulii

Exemplu de cerere

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

Listă paginabilă a regulilor.

Parametri de interogare

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

Exemplu de cerere

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

Creare sau modificare regulă. Pentru o regulă nouă data[id] = 0.

Câmpuri POST — obiectul data (câmpuri principale)

CâmpTipObligatoriuDescriere
idint0 = regulă nouă, >0 = modificare
receipt_rule_type_idintIdentificatorul tipului de regulă
source_receipt_type_idintIdentificatorul tipului de document sursă
dest_receipt_type_idintIdentificatorul tipului de document destinație (pentru conversie)
dest_receipt_closeint1 = închiderea automată a documentului destinație
company_idintIdentificatorul companiei
company_user_idintIdentificatorul angajatului emitent
receipt_cron_timestringExpresie de programare cron
printer_device_idintIdentificatorul dispozitivului de tipărire (pentru tipărire automată)
webhook_urlstringURL webhook (pentru trimitere automată)
webhook_headerstringAntet webhook (string JSON)
receipt_cron_limit_loopintProcesare maximă per ciclu (implicit: 10)
receipt_cron_limit_fullintProcesare totală maximă (implicit: 100)

Exemplu de cerere

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

{
  "data": {
    "id": 0,
    "receipt_rule_type_id": 1,
    "source_receipt_type_id": 5,
    "dest_receipt_type_id": 15,
    "company_id": 1,
    "company_user_id": 2,
    "receipt_cron_time": "0 6 * * *"
  }
}
POST /api/receipt_rule/delete

Ștergerea unei reguli pe baza identificatorului.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idintIdentificatorul regulii de șters

Exemplu de cerere

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

{ "data": { "id": 1 } }
POST /api/receipt_rule/run_rules

Rularea tuturor regulilor active pentru starea curentă a sistemului.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
dataobjectParametri opționali de filtrare

Exemplu de cerere

POST /api/receipt_rule/run_rules
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": {} }
POST /api/receipt_rule/run_rule

Rularea manuală a unei singure reguli.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idintIdentificatorul regulii de rulat

Exemplu de cerere

POST /api/receipt_rule/run_rule
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

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

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