API pentru gestionarea conținutului site-ului |

Documentație: informații de bază pentru interacțiunea cu API-ul de conținut al site-ului

Descriere

Această documentație descrie principiile de bază ale interacțiunii cu API-ul pentru lucrul cu conținutul site-ului, inclusiv metode de lucru cu categorii, produse și alte obiecte conexe.

Termeni generali de interacțiune

Antetul de autorizare în fiecare cerere (obligatoriu)

Fiecare solicitare API trebuie să conțină următorul parametru în anteturile sale:

API-Token: <Your_Token>

Exemplu de valoare API-Token: MY_TOKEN_123
Indicatorul este emis de managerul site-ului și trebuie transferat pentru a finaliza orice solicitare.
Variabila {{domain}} este emisă și de managerul dvs

Paginare

Paginarea de bază este aplicată tuturor punctelor finale.
Numărul de obiecte returnate per cerere este 100 în mod implicit.
Dacă este necesar, puteți modifica numărul de obiecte returnate la valoarea maximă - 5000 prin adăugarea unui parametru de interogare:

?page_size=
Pentru a solicita următoarele pagini, utilizați parametrul page**

?page=

*Opțiunile pot fi combinate în orice ordine

*
*

Exemple:

Primirea datelor cu paginare de bază (100 de obiecte pe pagină):

GET /extern/produs
Creșterea numărului de obiecte la 5000:

GET /external/product/?page_size=5000&page=2

Exemplu de solicitare API

Exemplu de solicitare folosind token și paginare:

curl --location „<http://admin.ecom.md/external/product”> \
--header „API-Token: MY_TOKEN_123” \
--header „Content-Type: application/json” \

3. Fiecare punct final de solicitare GET acceptă capacitatea de a prelua numai anumite date. De exemplu, dacă un produs are mai mult de 30 de câmpuri diferite, le puteți solicita doar pe cele de care aveți nevoie. Pentru a face acest lucru, transmiteți parametrul de interogarefields, *indicând câmpurile obligatorii separate prin* virgule, de exemplu:fields=id,code,name.

Note

Securitate token:
Vă rugăm să vă asigurați că „API-Token” furnizat este stocat în siguranță și nu este partajat cu terțe părți.
Gestionarea erorilor:
Un „Token API” lipsă sau nevalid va avea ca rezultat un cod de eroare 401 Neautorizat.
Asigurați-vă că simbolul dvs. este valid și transmis în antetul solicitării.
Solicitări API:
Toate solicitările trebuie făcute prin protocolul securizat HTTPS pentru a elimina riscul scurgerii de date confidențiale.
Limitele parametrului page_size:
Dacă valoarea page_size transmisă este mai mare de 5000 , atunci API-ul o va reduce automat la valoarea maximă acceptată.
Dacă nu transmiteți unele valori pentru un obiect în cerere, acestea vor fi ignorate de sistem și nu vor fi actualizate

Obiecte posibile pentru interacțiune:

A fost util articolul?

Da, multumesc! Din pacate nu