Acest ghid explică pe scurt cum să începeți să utilizați API-ul REST în ConnectedCooking. Vă rugăm să rețineți că acest ghid se referă exclusiv la soluțiile noastre de API REST în cloud.
- Mai întâi, trebuie să creați un client API în contul nostru ConnectedCooking. Pentru aceasta, accesăm fila „Administrare” din contul nostru ConnectedCooking.
- Apoi, faceți clic pe „Integrări”. Fila „API” este vizibilă doar pentru administratorii contului.
- Apoi dai clic pe „+ Adăugare nouă”
- În imaginea următoare, introduceți un „ALIAS”, atribuiți un GRUP și alegeți un tip de API. Pentru interogările API referitoare la HACCP și la datele din contul dvs. ConnectedCooking, aveți nevoie de tipul de API „Base API”. După ce completați toate coloanele, faceți clic pe „Add API”.
- În ecranul următor veți primi datele de autentificare ale clientului API. Vă rugăm să le păstrați într-un loc sigur și să faceți clic pe „Închide”.
- După ce ți-ai creat clientul API, ai nevoie de un instrument pentru a-l utiliza. În acest scop, poți folosi curl, Postman sau orice alt instrument cu care ești familiarizat. În acest ghid folosim Postman.
- Vă rugăm să porniți Postman din aplicație sau dintr-un browser web. Apoi, creați o colecție nouă goală folosind simbolul „+” și faceți clic pe „Adăugați o solicitare”. Alternativ, puteți crea pur și simplu o nouă solicitare HTTP făcând clic pe „Nou”.
- În plus, trebuie să modificați cererea nou creată, transformând-o într-o cerere POST, pentru a primi tokenul Bearer cu ajutorul datelor de autentificare ale clientului API de la ConnectedCooking.
- Prin urmare, trebuie să consultați documentația API-ului Autentificare | Centrul de ajutor ConnectedCooking
- Documentația explică faptul că trebuie să creați un token Bearer pentru a vă autentifica în cadrul solicitărilor ulterioare către API.
- Acest lucru se realizează printr-o cerere POST. Cererea POST utilizează punctul de acces: https://app.connectedcooking.com/api/auth/access
- În plus, trebuie să setați tipul de conținut „x-www-form-urlencoded” în fila „Corp” a cererii dumneavoastră. Apoi, numele de utilizator, parola și domeniul de aplicare ale clientului API trebuie introduse în coloanele disponibile.
- La final, faceți clic pe „Trimite” și ar trebui să primiți acum „accessToken = BearerToken”
- Pentru a utiliza BearerToken-ul pe care tocmai l-ai creat, ai nevoie de orice API care să îl accepte.
- Puteți verifica cu ușurință toate solicitările API posibile în documentația privind punctele de acces: Puncte finale | Centrul de ajutor ConnectedCooking
- De exemplu, încercați să utilizați punctul final „Lista dispozitivelor”.
- Această solicitare este foarte simplă, deoarece trebuie doar să folosiți „https://app.connectedcooking.com”, să adăugați „/api/public/devices” la acesta și să copiați/lipiți „accessToken”-ul din solicitarea POST în fila „Autorizare”, așa cum se vede în imaginea de mai jos. Trebuie doar să selectați „Bearer Token” la „Auth Type”, iar apoi va apărea câmpul „Token”.
- La final, apasă și pe „Trimite” și ar trebui să primești o listă cu toate dispozitivele înregistrate în contul tău ConnectedCooking (această listă este goală dacă nu ai niciun dispozitiv în cont).
Acest exemplu poate fi aplicat, în principiu, tuturor punctelor terminale.
Felicitări, acum poți folosi API-urile REST cu ConnectedCooking!
Dacă aveți nevoie de informații suplimentare, vă rugăm să consultați documentația API pentru ConnectedCooking: Introducere | Centrul de asistență ConnectedCooking
