Dokumentasi API Partner (API Documentation)

Dokumentasi ini menjelaskan cara integrasi endpoint API Partner Petoks yang siap dipakai oleh sistem pihak ketiga secara aman.

Endpoint Utama

Method: GET
URL: api/partner/pet-profile.php
Query wajib: pet_external_id

Contoh URL:

/api/partner/pet-profile.php?pet_external_id=pet_xxxx

Autentikasi

Gunakan salah satu metode berikut:

Header Authorization: Bearer YOUR_API_KEY
Header X-API-Key: YOUR_API_KEY
Query api_key=YOUR_API_KEY (hanya jika benar-benar dibutuhkan)

Scope yang Dibutuhkan

pet.profile.read

Jika scope tidak sesuai, API akan mengembalikan 403 Insufficient scope.

Contoh Request

curl -H "Authorization: Bearer YOUR_API_KEY" "https://domain-anda/api/partner/pet-profile.php?pet_external_id=pet_xxxx"

Contoh Response Sukses (200)

``json


{
  "success": true,
  "partner": {
    "id": 2,
    "name": "Partner A"
  },
  "pet": {
    "external_id": "pet_xxxx",
    "name": "Milo",
    "username": "milo.cat",
    "species": "cat",
    "breed": "persian",
    "gender": "male",
    "birth_date": "2023-05-10",
    "bio": "Friendly cat",
    "avatar_url": "...",
    "owner": {
      "external_id": "usr_xxxx",
      "name": "Ignaz"
    },
    "country": {
      "code": "ID",
      "name": "Indonesia"
    }
  },
  "profile": {
    "relationship": {},
    "vaccinations": [],
    "offspring": [],
    "certificates": []
  }
}



Error Code

401 Missing API key / Invalid API key

403 Insufficient scope / Country not allowed

404 Pet not found

422 pet_external_id is required

429 Rate limit exceeded

500 Internal server error


Catatan Integrasi

Selalu gunakan pet_external_id, bukan id` internal database.
Akses dicatat di log partner untuk audit dan monitoring.
Data yang dikembalikan bersifat read-only untuk endpoint ini.