Partner API dokumentace

Základní URL: https://skoda-hlaseni.cz/wp-json/partner-api/v1

Autorizace

Primární varianta: Authorization: Bearer <TOKEN>

Kompatibilní varianta je povolena: X-HS-Token: <TOKEN>

Scope dat pro partner token

Partner token vždy vrací pouze hlášení, která jsou přímo navázaná na partnera daného tokenu nebo na jeho subpartnery.

Jiný partner ani cizí větev partner stromu se přes tento token nevrátí. Pokud má partner u sebe nastavené omezení na konkrétní pojišťovny, vrátí se navíc jen hlášení odpovídající tomuto mapování.

Jak poznat, komu hlášení patří

Každé hlášení vrací pole partner_id a objekt partner se strukturou id, display_name, subdomain, parent_partner_id, root_partner_id a root_partner_name.

Díky tomu může partner rozlišit, zda hlášení patří přímo jemu nebo některému jeho subpartnerovi.

Endpointy

• GET /health
• GET /claims?updated_from=...&status=...&limit=50&page=1
• GET /claims/{event_uid}
• GET /claims/{event_uid}/media
• POST /claims/{event_uid}/ack

Stránkování seznamu hlášení

Endpoint GET /claims vrací standardně prvních 50 hlášení na stránku. Další stránku získáš parametrem page, například page=2.

V odpovědi jsou metadata count, total_count, page, per_page, total_pages, has_next_page, has_previous_page, next_page a previous_page.

Ukázka volání

curl -X GET "https://skoda-hlaseni.cz/wp-json/partner-api/v1/claims?limit=50&page=1" \
  -H "Authorization: Bearer PARTNER_TOKEN"

Stažení fotografií a médií

Detail hlášení i samostatný endpoint GET /claims/{event_uid}/media vrací média pouze pro hlášení dostupná v partner scope.

Každá položka média obsahuje alespoň file_url, mime_type, rozměry obrázku a čas vytvoření. Partner si může soubory stáhnout přímo přes vrácený file_url.

Ukázka struktury hlášení

{
    "event_uid": "HS-20260525093000-1234",
    "partner_id": 12,
    "partner": {
        "id": 12,
        "display_name": "ABCD CZ",
        "subdomain": "abcd",
        "parent_partner_id": 3,
        "root_partner_id": 3,
        "root_partner_name": "ABCD"
    },
    "media": [
        {
            "file_url": "https://.../photo.jpg",
            "mime_type": "image/jpeg"
        }
    ]
}

Webhook podpis

Při webhooku posíláme hlavičky X-HS-Signature a X-HS-Event-Id. Podpis je HMAC SHA256 z JSON body s použitím partnerova webhook_secret.