Colecție Postman

Postman este un client HTTP pentru proiectarea, testarea și partajarea cererilor către un API. Colecția Postman pentru e-bon este același set de cereri pe care îl folosim intern pentru smoke-test pe API și pentru onboarding-ul partenerilor POS — fiecare endpoint public din api.e-bon.ro este inclus, organizat pe resurse, cu placeholdere pentru cheia API, JWT, base URL și un id de dispozitiv pentru exemple. Pune-ți o singură dată credențialele în variabilele colecției și poți apela întreaga suprafață a API-ului din Postman, fără să scrii o linie de cod.

Colecția este cea mai rapidă cale să:

• explorezi interactiv API-ul înainte de a alege un SDK sau un client HTTP scris de mână;
• reproduci un bug raportat pe staging sau producție cu exact aceeași formă a cererii;
• dai unui dezvoltator junior un set funcțional de cereri ca să poată experimenta fără să citească mai întâi fiecare pagină de referință.

Vezi ce conține

Colecția cuprinde 77 de cereri grupate în 12 dosare de nivel 1, oglindind paginile pe resurse din această secțiune a documentației:

• Health — 2 cereri
• Auth — 5 cereri
• Organization — 8 cereri
• API Keys — 5 cereri
• Devices — 24 cereri
• Fiscal Operations — 6 cereri
• Commands — 4 cereri
• Receipts — 2 cereri
• Reports — 10 cereri
• Billing — 6 cereri
• Users — 4 cereri
• App Instances — 1 cerere

Numerele de mai sus sunt extrase direct din JSON-ul colecției; dacă vreuna pare în neregulă, fișierul JSON din repo este sursa de adevăr.

Importă colecția

Configurează variabilele

Colecția vine cu patru variabile la care fiecare cerere face referire prin placeholdere de forma {{variabilă}}. Le setezi o singură dată la nivel de colecție și toate cererile le preiau automat.

Două medii (environment) gata de folosit:

Producție

Dezvoltare locală

Pentru a obține o cheie API și un token, urmează pașii din pagina de Autentificare.

Autentifică-ți cererile

Colecția include ambele fluxuri de autentificare suportate de API:

• Cheie API — majoritatea dosarelor de resurse (Devices, Commands, Receipts, Reports, Billing) trimit antetul x-api-key: {{apiKey}} și țintesc rutele de producție pe care le-ai apela dintr-o integrare POS.
• JWT Bearer — dosarul Auth exersează POST /auth/register, POST /auth/login, POST /auth/refresh și POST /auth/logout. Răspunsul de la login scrie tokenul de acces în {{token}}, astfel încât cererile ulterioare doar-JWT sunt autentificate automat.

Alege fluxul potrivit scenariului tău: un partener POS sau o integrare back-office vrea aproape întotdeauna fluxul cu cheie API; folosește JWT doar când exersezi aceleași endpoint-uri pe care le folosește interfața Portalului în numele unui utilizator autentificat.

Pentru contextul mai larg — formatul cheii, permisiuni, rotație, învelișul de eroare — vezi Autentificare și ghidul din Portal de la Chei API.

Trimite prima cerere

Începe cu Health → GET health. Apelează GET {{baseUrl}}/health, nu cere nici cheie API, nici JWT, și răspunde cu un mic body JSON de stare. Dacă întoarce 200 OK, ai dovedit că:

1. baseUrl-ul este accesibil.
2. Postman poate vorbi cu API-ul e-bon din rețeaua ta.
3. Nimic din configurația de TLS / proxy / VPN nu blochează cererea.

După ce Health trece, treci la Auth → POST login (pentru JWT) sau direct la Devices → GET devices cu apiKey-ul completat.

Rezolvă erorile frecvente

Vezi și

• Privire de ansamblu API — base URL, învelișul de eroare, limite de rată și reguli de idempotență.
• Autentificare — referința completă pentru cheie API și JWT, inclusiv cum se generează și cum se rotește o cheie.
• Privire de ansamblu SDK — pentru când treci de Postman și vrei un client tipat.
• Pornire rapidă pentru dezvoltatori — aceleași fluxuri exprimate ca apeluri curl și fragmente de cod.

Descarcă colecția

Descarcă colecția — e-bon-api.postman_collection.json, Postman Collection v2.1.0.