Dokumentacja API
Trzy zasoby tylko do odczytu. Odpowiedzi mają format JSON z polami po angielsku; teksty produktów są po polsku.
Zasoby
- Produkt po kodzieGET /products/{code}
- Wyszukiwanie produktówGET /products
- Drzewo kategoriiGET /categories
Opis API w formacie OpenAPI 3.1 — wczytasz go do Postmana albo wygenerujesz z niego klienta.
Produkt po kodzie
GET/products/{code}
Pełna karta produktu. Kod może być w każdym formacie z wyszukiwarki (EAN-13, EAN-8, UPC-A, UPC-E, GTIN-14); dodatkowy kod po scaleniu duplikatów zwraca produkt główny z polem requestedCode.
Parametry
| Nazwa | Gdzie | Wymagany | Opis |
|---|---|---|---|
| code | ścieżka | tak | kod EAN, UPC albo GTIN |
Przykładowa odpowiedź
Błędy: 400 invalid_code, 404 not_found
curl -H "Authorization: Bearer $EPHEMERIS_KEY" \
"https://api.ephemeris.coruls.com/v1/products/5901234123457"Wypróbuj
Wyszukiwanie produktów
GET/products
Wyszukiwanie po nazwie, marce i producencie bez względu na polskie znaki, ze stronicowaniem.
Parametry
| Nazwa | Gdzie | Wymagany | Opis |
|---|---|---|---|
| q | zapytanie | nie | szukana fraza; puste pole zwraca wszystkie produkty |
| category | zapytanie | nie | identyfikator kategorii z /categories, razem z podkategoriami |
| page | zapytanie | nie | numer strony, od 1 |
| perPage | zapytanie | nie | liczba wyników na stronie, do 50 (domyślnie 20) |
Przykładowa odpowiedź
Błędy: 400 invalid_category
curl -H "Authorization: Bearer $EPHEMERIS_KEY" \
"https://api.ephemeris.coruls.com/v1/products?q=jogurt&page=1&perPage=2"Wypróbuj
Drzewo kategorii
GET/categories
Wszystkie kategorie z liczbą produktów i kodem GS1 GPC liści (pole gpc).
Parametry
Ten zasób nie ma parametrów.
Przykładowa odpowiedź
Fragment odpowiedzi — pełna lista jest dłuższa.
Błędy: tylko błędy wspólne: 401, 403, 429
curl -H "Authorization: Bearer $EPHEMERIS_KEY" \
"https://api.ephemeris.coruls.com/v1/categories"