Przejdź do głównej zawartości

Klucz API

Wszystkie zapytania do API DPay Web EID wymagają klucza API przesyłanego jako Bearer token w nagłówku Authorization.

Generowanie klucza

Klucz API otrzymasz w panelu administracyjnym pod adresem /admin/api-keys. Każdy klucz przypisany jest do tenanta i może być dezaktywowany lub odwołany w dowolnym momencie.

Format klucza

ŚrodowiskoPrefiksPrzykład
Produkcjadeid_live_deid_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Test / Sandboxdeid_test_deid_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Oba klucze działają identycznie pod względem API. Różnica polega na tym, że sesje utworzone kluczem testowym są oznaczane jako testowe i nie są naliczane w bilingu.

Użycie w zapytaniu

curl https://hub.dpay.pl/api/v1/verifications \
-H "Authorization: Bearer deid_live_twoj_klucz_api" \
-H "Content-Type: application/json"

Bezpieczeństwo

Nigdy nie ujawniaj klucza
  • Nie commituj klucza do repozytorium kodu
  • Nie umieszczaj klucza w kodzie frontendowym ani aplikacjach mobilnych
  • Przechowuj klucz wyłącznie w zmiennych środowiskowych serwera (.env, secrets vault)
  • W przypadku wycieku - natychmiast odwołaj klucz w panelu i wygeneruj nowy

Kody błędów autoryzacji

Kod HTTPKod błęduOpis
401AUTHENTICATION_REQUIREDBrak nagłówka Authorization
401INVALID_API_KEYKlucz nieprawidłowy, wygasł lub został unieważniony
401TENANT_NOT_FOUNDNie znaleziono tenanta dla tego klucza
403TENANT_SUSPENDEDKonto tenanta zostało zawieszone

Przykładowa odpowiedź błędu

{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid, expired, or has been revoked."
}
}