Dokumentacja API

Zalogowani użytkownicy mogą zarządzać własnymi źródłami ofert, produktami i ofertami przez wersjonowane REST API.

Uwierzytelnianie

Utwórz osobisty token dostępu za pomocą adresu e-mail i hasła, a następnie wysyłaj go jako token Bearer.

POST https://comparer.oferta360.pl/api/v1/tokens
{
  "email": "[email protected]",
  "password": "secret",
  "token_name": "woocommerce"
}

Endpointy

Metoda Ścieżka Opis
POST https://comparer.oferta360.pl/api/v1/tokens Tworzy osobisty token dostępu.
DELETE https://comparer.oferta360.pl/api/v1/tokens/current Unieważnia token użyty w bieżącym żądaniu.
GET/POST https://comparer.oferta360.pl/api/v1/offer-sources Lista lub tworzenie źródeł ofert należących do zalogowanego użytkownika.
GET/PATCH/DELETE https://comparer.oferta360.pl/api/v1/offer-sources/{id} Podgląd, aktualizacja lub usunięcie jednego własnego źródła ofert.
GET/POST https://comparer.oferta360.pl/api/v1/products Lista lub tworzenie produktów należących do zalogowanego użytkownika.
GET/PATCH/DELETE https://comparer.oferta360.pl/api/v1/products/{id} Podgląd, aktualizacja lub usunięcie jednego własnego produktu.
GET/POST https://comparer.oferta360.pl/api/v1/offers Lista lub tworzenie ofert należących do zalogowanego użytkownika.
GET/PATCH/DELETE https://comparer.oferta360.pl/api/v1/offers/{id} Podgląd, aktualizacja lub usunięcie jednej własnej oferty.

Zasady weryfikacji

Rekordy utworzone lub zaktualizowane przez API działają jak w panelu konta: produkty stają się szkicem i są nieaktywne, źródła ofert mają status oczekujący i token weryfikacji, a oferty są nieaktywne do czasu przeglądu.

Przykładowe żądanie

curl -H "Authorization: Bearer TOKEN" \
  -H "Accept: application/json" \
  https://comparer.oferta360.pl/api/v1/products