Kedvencem Partner API

API dokumentáció

Csatlakoztasd a saját rendszeredet a Kedvencem apphoz: állatadat feltöltés, bejelentés rögzítés és egységes JSON API.

Base URL: https://kedvencem.hu/api/v1

Gyors indulás

  1. API kulcsot partneri egyeztetés után tudunk biztosítani.
  2. Másold el a kulcsot (provider végpontnál a secretet is).
  3. Küldj JSON kérést a megfelelő végpontra a dokumentáció alapján.
Kapcsolatfelvétel API kulcshoz

A webes belépési felület jelenleg nem publikus látogatói belépésre szolgál.

Hitelesítés

Minden írási kéréshez hitelesítés szükséges.

Bejelentések API

Authorization: Bearer <api_key> vagy X-API-Key

Provider API

X-Provider-Key + X-Timestamp + X-Signature

Végpontok

A legfontosabb API útvonalak.

GET /api/v1/health

Állapot ellenőrzés

POST /api/v1/reports

Bejelentés beküldése

POST /api/v1/providers/{provider}/animals:upsert

Állatok létrehozása vagy frissítése

POST /api/v1/providers/{provider}/animals:deactivate

Állatok inaktiválása

Válaszkódok

A leggyakoribb API válaszok.

200 / 201 Sikeres mentés
401 Hibás vagy hiányzó API kulcs
422 Validációs hiba
500 Belső hiba

Részletes minták partneri hozzáféréssel

A teljes JSON minták és az API kulcs igénylés partneri hozzáféréssel érhető el.

Kapcsolatfelvétel