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. Nyisd meg a Profil / Api menüt és hozz létre API kulcsot.
  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.
Belépés az API kulcsokhoz

Google, Apple és e-mail/jelszó belépés is elérhető.

Hitelesítés

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

Bejelentések API

Authorization: Bearer <api_kulcs> 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 belépés után

A teljes JSON minták és az API kulcs igénylés bejelentkezés után, a Profil / Api menüpontban érhető el.

Belépés