Documentație API pentru lucrul cu mărci
Tabel cu descrierile câmpurilor
| Câmp | Tip | Necesar? | Descriere |
|---|---|---|---|
id| int |
Nu | Identificator unic de marcă (necesar la actualizare). | |
nume| sfoară |
Da | Nume de marcă. | |
descriere| sfoară |
Nu | Descrierea mărcii. | |
imagine| dosar |
Nu | Imagine de marcă (maximum 250 KB). | |
melc| sfoară |
Da | Identificator de marcă unic pentru adrese URL. | |
ascunde| boolean |
Nu | Este marca ascunsă? Valoarea implicită este „True”. | |
comanda| int |
Nu | Valoarea ordinală a mărcii pentru sortare. | |
link| sfoară |
Nu | Site-ul de marcă (URL). | |
seo_title| sfoară |
Nu | Titlul SEO. | |
seo_keywords| sfoară |
Nu | Cuvinte cheie SEO. | |
seo_description| sfoară |
Nu | Descriere SEO. | |
este_prezentat| boolean |
Nu | Dacă marca este marcată ca favorită. Valoarea implicită este „False”. |
Puncte finale
1. Obținerea tuturor mărcilor
Descriere : returnează o listă cu toate mărcile de pe site. Acceptă filtrarea după ora ultimei actualizări.
Punctul final :
[GET] /extern/brand/
Răspuns:
[ { „id”: 1, "name": "Nume de marcă", "description": "Text de descriere a mărcii", "image": "https://example.com/image.jpg", "slug": "nume de marcă", „ascunde”: fals, "comanda": 1, "link": "https://brand-website.com", "seotitle": "Titlul SEO al mărcii", "seokeywords": "cuvânt cheie1, cuvânt cheie2", "seodescription": "Descrierea SEO a mărcii", „esteprezentat”: adevărat } ]
2. Obținerea unei mărci
Descriere : returnează informații despre o singură marcă prin ID.
Punctul final :
[GET] /extern/brand/{id}/
Parametri URL:
id(int) : identificator unic de marcă.
Răspuns:
{ „id”: 1, "name": "Nume de marcă", "description": "Text de descriere a mărcii", "image": "https://example.com/image.jpg", "slug": "nume de marcă", „ascunde”: fals, "comanda": 1, "link": "https://brand-website.com", "seotitle": "Titlul SEO al mărcii", "seokeywords": "cuvânt cheie1, cuvânt cheie2", "seodescription": "Descrierea SEO a mărcii", „esteprezentat”: adevărat }
3. O actualizare a mărcii
Descriere : vă permite să actualizați datele pentru o singură marcă.
Punctul final :
[PUT] /external/brand/{id}/
Exemplu de solicitare:
{ "name": "Nume de marcă actualizat", "slug": "nume-marca-actualizat", "description": "Descriere actualizată", "comanda": 2, „este_prezentat”: adevărat }
Răspuns:
{ „id”: 1, "name": "Nume de marcă actualizat", "slug": "nume-marca-actualizat", "description": "Descriere actualizată", "comanda": 2, „este_prezentat”: adevărat }
4. Actualizare masivă a mărcii
Descriere: Vă permite să actualizați mai multe mărci în același timp.
Punctul final :
[PUT] /extern/brand/bulk-update/
Exemplu de solicitare:
[ { „id”: 1, "name": "Marcă 1 actualizată", "comanda": 1, „esteprezentat”: adevărat }, { „id”: 2, "name": "Marcă actualizată 2", "comanda": 2, „isfeatured”: fals } ]
Răspuns:
[ { „id”: 1, "name": "Marcă 1 actualizată", "comanda": 1, „esteprezentat”: adevărat }, { „id”: 2, "name": "Marcă actualizată 2", "comanda": 2, „isfeatured”: fals } ]
5. Creare de brand în masă
Descriere: vă permite să creați mai multe mărci într-o singură solicitare.
Punctul final :
[POST] /external/brand/bulk-create/
Exemplu de solicitare:
[ { "name": "New Brand 1", "slug": "new-brand-1", "description": "Descriere pentru marca 1", "comanda": 1, „isfeatured”: fals, „ascunde”: fals }, { "name": "New Brand 2", "slug": "new-brand-2", "description": "Descriere pentru marca 2", "comanda": 2, „isfeatured”: adevărat, „ascunde”: fals } ]
Răspuns:
[ { „id”: 1, "name": "New Brand 1", "slug": "new-brand-1", "description": "Descriere pentru marca 1", "comanda": 1, „isfeatured”: fals, „ascunde”: fals, „imagine”: nul, „link”: nul, „seotitle”: nul, „seokeywords”: nul, "seodescription": null }, { „id”: 2, "name": "New Brand 2", "slug": "new-brand-2", "description": "Descriere pentru marca 2", "comanda": 2, „isfeatured”: adevărat, „ascunde”: fals, „imagine”: nul, „link”: nul, „seotitle”: nul, „seokeywords”: nul, "seodescription": null } ]
Gestionarea erorilor
Atât punctele finale bulk-update, cât și bulk-create gestionează următoarele erori:
- Eroare de integritate (slug-ul există deja) : returnează un mesaj de eroare dacă
slugspecificat este deja utilizat de o altă marcă pe acest sistem. - Date nevalide: returnate dacă datele transmise sunt nevalide.
- Negăsit (numai pentru actualizarea în bloc): returnat dacă ID-ul de marcă specificat nu este găsit în sistem.
A fost util articolul?
Da, multumesc! Din pacate nu