BillyouAjutor

↑↓ alegi · ↵ deschizi · Esc închizi

Autentificare

Pe această pagină

Scop

Fiecare cerere este autentificată pe o organizație. Varianta obișnuită este cheia de API. Cealaltă este un token OAuth 2.0 client-credentials.

Pagina în engleză, cu aceleași reguli, este Authentication.

Chei de API

Cheia se trimite în X-API-Key sau în Authorization cu schema ApiKey:

X-API-Key: bk_user_<64 caractere hex>
Authorization: ApiKey bk_user_<64 caractere hex>

Prefixul este bk_user_ și în producție, și în sandbox. O cheie bk_user_ trimisă ca Authorization: Bearer este respinsă.

Nu există scope-uri. Cheia aparține unei organizații și unui mediu (production sau sandbox; implicit sandbox). O cerere fără header-ul Billyou-Version se rezolvă la 2026-08-01, nu la o versiune salvată pe cheie. Vezi Versionarea API. Implicit, toate cheile organizației împart aceeași limită: 60 de cereri pe minut. Billyou poate seta o limită diferită, iar rutele de partener au un prag propriu. Vezi Limite de rată.

Cheile se creează, se rotesc și se șterg în portalul pentru dezvoltatori, la API Keys. În aplicație, intrarea se numește Portal Dezvoltatori și este vizibilă când contul are flag-ul hasapi. Nu se generează din Setări → API & Integrations.

Expirarea este opțională (implicit niciodată). Poți roti sau șterge o cheie. O organizație poate avea cel mult 25 de chei.

Bearer

Authorization: Bearer este acceptat doar pentru:

  • un JWT de sesiune Kinde
  • un token de acces OAuth client-credentials, cu prefix bk_at_

Tokenul se obține de la POST /api/oauth/token cu grant_type=client_credentials. Este valabil o oră și are aceleași drepturi ca o cheie de API. Detaliile sunt în referința OAuth.

Erori

O credențială lipsă sau respinsă întoarce HTTP 401:

{ "success": false, "errorCode": "UNAUTHORIZED", "message": "..." }

Nu există eroarea insufficient_scope. Vezi Errors și Rate limits.

Documente înrudite