Cum creezi și administrezi cheile API
O cheie API este un set de credențiale, adică un utilizator și un secret prin care o aplicație sau un sistem extern poate citi ori modifica date din magazin. Creează o cheie separată pentru fiecare integrare, astfel încât să poți limita, urmări și retrage accesul individual.
Folosește o cheie API când un sistem trebuie să lucreze automat cu datele magazinului. Pentru o persoană care intră în dashboard, creează în schimb un utilizator al echipei.
Începe cu acces de citire pentru o singură resursă și testează numai operația minimă cerută. Extinde permisiunile sau activează scrierea după ce integratorul sistemului extern confirmă rezultatul; o cheie cu acces de scriere poate modifica date reale.
Pagina este disponibilă când magazinul are activat accesul API.
Creează cheia API
- Accesează Setari > API si webhook-uri > Chei API.
- Apasă Adauga API Key.
- Completează Denumire interna cu numele sistemului sau al integrării care va folosi cheia.
- Activează numai resursele necesare și alege acces de citire sau de scriere pentru catalog, comenzi, clienți și blog, după caz.
- Verifică permisiunile suplimentare pentru discounturi, rapoarte, website, template-uri sau storefront.
- Apasă Salveaza.
- Copiază valorile Utilizator API și API secret și transmite-le integratorului sistemului extern printr-un canal sigur.
Secretul permite autentificarea sistemului extern. Nu îl include în capturi de ecran, tichete publice, mesaje nesecurizate sau cod care ajunge în storefront. Dacă a fost expus, generează imediat un secret nou.
Limitează permisiunile
| Ce trebuie să facă integrarea | Acces potrivit |
|---|---|
| Doar preia produse, comenzi sau clienți | Citire pentru resursele necesare |
| Creează sau actualizează date | Scriere numai pentru resursele modificate |
| Folosește mai multe servicii independente | Câte o cheie separată pentru fiecare serviciu |
După configurare, testează operația minimă necesară și verifică în listă coloana Ultima accesare. Faptul că o cheie nu a fost încă folosită poate indica o configurare incompletă în sistemul extern.
Modifică sau retrage accesul
În lista Chei API poți:
- să copiezi explicit utilizatorul sau secretul;
- să apeși Editeaza pentru a modifica denumirea și permisiunile;
- să dezactivezi temporar cheia din coloana Status;
- să folosești Resetare parola API pentru a genera un secret nou;
- să folosești Stergere pentru a elimina definitiv cheia.
Resetarea secretului invalidează valoarea anterioară. Actualizează sistemul extern cu noua valoare înainte să reiei sincronizarea.
Cheile create și controlate de o aplicație instalată pot apărea în listă, dar nu pot fi editate, dezactivate, resetate sau șterse de aici. Administrează în schimb aplicația asociată.
Dacă integrarea nu se conectează
- Verifică dacă cheia are statusul activ și dacă sistemul folosește perechea corectă Utilizator API și API secret.
- Confirmă că resursa și nivelul de citire sau scriere necesare sunt permise.
- Rulează operația minimă și verifică dacă se actualizează Ultima accesare.
- Dacă accesarea apare, dar operația eșuează, verifică împreună cu integratorul sistemului extern adresa API și formatul cererii.
Pentru verificarea cererii, trimite integratorului sistemului extern data și ora testului, endpointul folosit — adică adresa tehnică a operației — și codul HTTP primit. Dacă cheia este activă, permisiunile sunt corecte și cererea respectă documentația API, dar răspunsul MerchantPro rămâne neașteptat, contactează echipa de suport MerchantPro și indică denumirea internă a cheii, data și ora testului, endpointul și codul HTTP.
Verifică rezultatul
- Fiecare sistem extern folosește propria cheie.
- Permisiunile includ numai resursele și nivelul de acces necesare.
- Integrarea poate efectua operația testată.
- Data ultimei accesări se actualizează după utilizare.
- Cheile vechi sau nefolosite sunt dezactivate ori șterse.
Pentru autentificare, endpointuri, formate de răspuns și exemple de implementare, consultă documentația API pentru dezvoltatori.