EDD REST API include șase endpoint-uri pentru accesarea informațiilor, fiecare pentru efectuarea unui tip specific de cerere:
- stats – Pentru preluarea statisticilor de câștiguri/vânzări pentru date specifice, intervale de date și produse specifice.
- products – Pentru preluarea informațiilor despre produsele magazinului.
- customers – Pentru preluarea statisticilor clienților.
- sales – Pentru preluarea vânzărilor recente și a informațiilor despre fiecare vânzare (articole achiziționate, cumpărător, sumă etc.).
- discounts – Pentru preluarea informațiilor despre toate reducerile disponibile.
- download-logs – Pentru preluarea jurnalelor de descărcare a fișierelor.
Endpoint-urile sunt utilizate astfel:
https://example.com/edd-api//
De exemplu:
https://example.com/edd-api/sales/
Când este combinat cu cheia API și token-ul, URL-ul complet arată astfel:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Vizibilitate
Toate endpoint-urile necesită cheia API și token-ul, cu excepția endpoint-ului products. Acest lucru se datorează faptului că produsele sunt destinate să fie publice în permanență în mod implicit.
Formatul răspunsului
Răspunsul oferit de API-ul EDD este disponibil în două formate:
Pentru a specifica formatul returnat (JSON va fi utilizat dacă nu este specificat niciunul), pur și simplu adăugați argumentul
format la URL:
https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml
Un exemplu de răspuns JSON arată astfel:
{
"sales": [
{
"ID": 611,
"subtotal": "20",
"tax": 0,
"fees": false,
"total": "20",
"gateway": "manual",
"email": "[email protected]",
"date": "2013-02-25 11:42:05",
"products": [
{
"name": "Simple Notices Pro",
"price": "20",
"price_name": "Price one"
}
]
}
]
}
Un exemplu de răspuns XML (pentru aceeași interogare) arată astfel:
611
20
0
false
20
manual
[email protected]
2013-02-25 11:42:05
Simple Notices Pro
20
Price one
Variabile URL opționale
Puteți adăuga variabile URL suplimentare pentru a ajusta ieșirea oferită. Iată câteva exemple de modalități prin care puteți face acest lucru.
- Număr: În mod implicit, API-ul va afișa 10 rezultate pe pagină, dacă așa este setat în setările de citire din WordPress. Dar dacă doriți să schimbați acest lucru pentru o anumită cerere API, puteți adăuga „&number=11” la URL pentru a obține un număr diferit de rezultate pe pagină. În acest exemplu, ați obține 11 rezultate.
- Pagină: În mod implicit, API-ul va afișa pagina 1 a rezultatelor. Dacă doriți să schimbați acest lucru pentru o anumită cerere API, puteți adăuga „&page=2” la URL pentru a obține o pagină diferită de rezultate.
