Cum te conectezi la API-ul easySales: clienți OAuth și tokenuri de acces personale
Creează clienți OAuth și tokenuri de acces personale pentru API-ul easySales, alege tipul de grant și scopurile potrivite și evită ca o conexiune să o deconecteze pe alta.
La ce folosesc setările API
API-ul easySales le permite sistemelor tale și sistemelor partenerilor tăi să citească și să modifice datele tale: produse, stoc, comenzi, facturi și altele. Setări API este locul în care creezi datele de acces pe care le folosesc. Deschide pagina din Setări → Cont → Setări, cu butonul Setări API, sau din Setări pagini → Integrări → Setări API.
Trei lucruri de știut de la început:
- Un singur token activ pe conexiune. Când un sistem cere un token nou, tokenul anterior al aceleiași conexiuni nu mai funcționează. Dă fiecărui sistem propriul client și lasă-l să își refolosească tokenul, în loc să ceară unul nou de fiecare dată.
- Un token de acces personal se afișează o singură dată. Copiază-l când îl creezi. Dacă îl pierzi, creează unul nou; cel vechi nu mai funcționează.
- Alege scopurile cu atenție. Un token poate face doar ce îi permit scopurile lui, iar scopurile nu se mai pot schimba ulterior.
| Secțiune | Ce conține |
|---|---|
| OAuth Client | Clienții pe care sistemele tale îi folosesc ca să obțină tokenuri, cu ID Client, Tipul de grant și Secret. |
| Aplicații autorizate | Aplicațiile care au un token de la unul dintre clienții tăi de tip website sau redirect, cu scopurile lor. Revoca oprește una dintre ele. |
| Token de acces personal | Tokenurile tale de acces personale, după nume. Șterge oprește unul. |
Creează un client OAuth
- Apasă Creați un client nou.
- Dă-i un Nume pe care îl recunoști, de exemplu numele sistemului care îl va folosi.
- Alege Tipul de grant. Pentru Redirect Flow Grant, introdu și URL-ul de redirecționare al aplicației tale.
- Apasă Creează. Clientul apare în listă cu ID Client și Secret.
| Tipul de grant | Îl folosești pentru |
|---|---|
| Website Grant | Un modul de magazin online sau un magazin personalizat conectat la easySales. Pe lângă ID-ul clientului și secret, folosește tokenul de website al magazinului, pe care îl primești când conectezi magazinul din Integrări. |
| Password Grant | Propriul tău sistem, care își obține tokenul cu datele de login ale contului tău easySales. |
| Redirect Flow Grant |
O aplicație la care aprobi accesul în easySales și ești trimis înapoi în aplicație. URL-ul de redirecționare trebuie să folosească un nume de host, precum localhost sau un domeniu, nu o adresă IP.
|
Editează schimbă doar numele și URL-ul de redirecționare. Ca să schimbi secretul, creează un client nou, mută-ți sistemul pe el, apoi folosește Șterge pe cel vechi. Ștergerea unui client oprește imediat toate tokenurile emise cu el.
Creează un token de acces personal
Un token de acces personal este un token gata făcut pentru un script, un instrument sau un partener care are nevoie doar să apeleze API-ul.
- Apasă Creați un token nou.
- Dă-i un Nume și bifează la Scopuri ce îi trebuie, sau alege Selectează tot.
- Apasă Creează și copiază tokenul imediat.
Contul tău are un singur token de acces personal la un moment dat: crearea unuia nou îl oprește pe cel anterior. Dacă doi parteneri au nevoie de acces, dă-le în schimb clienți OAuth.
Folosește API-ul
- Trimite cererile la
https://easy-sales.com/api/v2, cu headereleAuthorization: Bearerurmat de tokenul tău șiAccept: application/json. - Tokenurile sunt valabile un an. Păstrează tokenul și refolosește-l până atunci.
- Contul tău poate face până la 500 de cereri pe minut, împărțite între toate tokenurile lui.
- Endpointurile, câmpurile și exemplele se găsesc în documentația API, la api.easy-sales.com.
Echipa ta și setările API
Membrii echipei cu permisiunea Accesare setări pot deschide Setări API și îți pot vedea clienții OAuth, inclusiv secretele lor, dar nu îi pot crea, edita sau șterge și nu văd tokenurile de acces personale. Acordă această permisiune doar persoanelor care trebuie să aibă acces la datele tale de acces API.
Când ceva nu arată cum trebuie
| Simptom | Ce faci |
|---|---|
| API-ul răspunde „Unauthenticated.” | Tokenul a fost înlocuit de unul mai nou de la același client sau a expirat. Folosește câte un client pentru fiecare sistem și păstrează tokenul pe care l-a primit. |
| API-ul răspunde „Invalid scope(s) provided.” | Tokenul nu are scopul necesar pentru această cerere. Creează un token nou cu scopul bifat. |
| Mi-am pierdut tokenul de acces personal | Nu mai poate fi afișat. Creează unul nou; cel vechi nu mai funcționează. |
| API-ul returnează o pagină web în loc de JSON |
Adaugă headerul Accept: application/json la cererile tale.
|
| „Too Many Attempts.” | Contul tău a depășit 500 de cereri pe minut. Rărește cererile și refolosește tokenul. |
| Un partener a pierdut accesul când am creat un token | Crearea unui token de acces personal îl oprește pe cel anterior. Dă fiecărui partener propriul client OAuth. |