Nexus GatewayCâteva concepte acoperă întreaga integrare. Citește această pagină înainte de ghidul rapid; toate celelalte ghiduri folosesc acești termeni.
Componentele
Website-ul tău nu apelează niciodată Nexus direct. Backendul păstrează cheia website și efectuează toate cererile. Restaurantul controlează meniul și decide asupra fiecărei comenzi; gateway-ul le conectează.
Termeni esențiali
| Termen | Semnificație |
|---|---|
| Tenant | Compania de restaurante cu care faci integrarea. Poate avea mai multe locații. |
| Cheie website | Cheia ta API secretă. Identifică tenantul și trebuie să rămână în backend. |
| Conexiune | Un punct care primește comenzi de pe website: o locație și casa sa de marcat. Fiecare cerere pentru meniu, comandă sau stare indică un ID de conexiune. |
| Register | Punctul de vânzare (POS) unde personalul restaurantului vede, acceptă și onorează comenzile. |
| Revizia meniului | Versiunea unui meniu publicat. O trimiți cu fiecare comandă pentru ca prețurile să fie verificate față de ceea ce a văzut clientul. |
| Bani | Subdiviziunea leului românesc. Toate sumele sunt întregi, în bani: 3700 înseamnă 37,00 RON. |
| Variantă, componentă inclusă, extra | Cele trei tipuri de opțiuni: una definitorie, precum mărimea, o componentă inclusă, precum băutura, și un adaos contra cost, precum brânza suplimentară. |
| ID extern al comenzii | ID-ul pe care îl generezi pentru o achiziție. Refolosirea lui face reîncercările sigure; aceeași conexiune și același ID nu pot crea o a doua comandă. Același ID pe altă conexiune reprezintă o altă comandă. |
O comandă, de la început la sfârșit
- Restaurantul activează comenzile website pentru o casă de marcat și publică meniul din Retail Admin.
- Backendul tău listează conexiunile tenantului și o alege pe cea a locației selectate de client.
- Citește meniul acelei conexiuni și îl afișează pe website.
- Clientul formează coșul. Backendul calculează totalul din meniu.
- Backendul salvează comanda cu un ID propriu, apoi o trimite.
201înseamnă că restaurantul a primit-o, nu că a și acceptat-o. - Personalul acceptă sau respinge comanda în Register.
- Backendul primește actualizări webhook semnate și afișează progresul clientului. Citește starea curentă pentru reconcilierea actualizărilor pierdute; citirea periodică este alternativa fără webhook-uri.
Înregistrează un webhook înainte de trimiterea comenzilor pentru actualizări confirmate ale stării. Citirea periodică rămâne disponibilă pentru reconciliere.
Ce nu face API-ul
- Încasarea plății. Procesatorul tău încasează și rambursează. Tu comunici către Nexus cum este plătită comanda.
- Alocarea curierilor sau estimarea livrării. Zonele de livrare și curierii rămân în responsabilitatea ta și a restaurantului.
- Administrarea clienților. Comenzile conțin doar nume și telefon; conturile și marketingul rămân la tine.
În continuare: efectuează primele cereri folosind ghidul rapid.