API

Secțiunea API din Portal grupează într-un singur loc toate suprafețele de comunicare mașină-la-mașină. Reflectă tab-ul API al aplicației portal la /portal/api, care se împarte în două vizualizări — Chei și Webhook-uri — acoperind cele două jumătăți ale oricărei integrări cu platforma e-bon.

• Chei — creează, restricționează prin permisiuni și revocă cheile API pe care partenerii POS și sistemele externe le folosesc pentru a se autentifica la API-ul REST e-bon. Cheile sunt modul în care un sistem extern trage date din e-bon: trimite o cheie în antetul Authorization și citește bonuri, dispozitive, rapoarte sau pune la coadă comenzi, în limita permisiunilor acordate acelei chei.
• Webhook-uri — configurează endpoint-urile HTTPS către care e-bon împinge payload-uri de evenimente semnate atunci când se întâmplă ceva (este emis un bon, se închide un raport Z, un dispozitiv trece offline). Webhook-urile sunt modul prin care sistemele tale află despre evenimente în momentul în care se produc — fără polling.

Majoritatea integrărilor folosesc ambele: o cheie API ca sistemul tău să poată citi și acționa pe datele e-bon, și unul sau mai multe abonamente la webhook-uri ca e-bon să poată notifica sistemul tău în momentul în care un eveniment relevant se produce.

Pași următori

• Chei — credențialul pentru citire. Cheile API trag date.
• Webhook-uri — abonamentul pentru push. Webhook-urile livrează evenimente.
• Referința API — întreaga suprafață mașină-citibilă cu care vorbesc aceste chei și webhook-uri.