Dla firm
REST API
Zarzadzanie aplikacjami OAuth i weryfikacjami dokumentow z kodu. Wszystko, co da sie zrobic w panelu, da sie zrobic kluczem API.
Spis treści
Uwierzytelnianie
Klucz wygenerujesz w panelu firmy. Pokazujemy go dokladnie raz — w bazie trzymamy tylko skrot, wiec zgubionego klucza nie odzyskamy, mozna go jedynie uniewaznic i wystawic nowy.
Authorization: Bearer elg_live_xxxxxxxxxxxxxxxxxxxx
Klucz identyfikuje firme, nie uzytkownika. Nie da sie nim odczytac danych osobowych zadnego uzytkownika — do tego sluzy OAuth i zgoda konkretnej osoby.
Zarzadzanie aplikacjami
| Metoda i sciezka | Opis |
|---|---|
GET /api/v1/me | Dane firmy i status weryfikacji. |
GET /api/v1/scopes | Katalog zakresow z opisami i claimami. Zrodlo prawdy — nie kopiuj listy do kodu. |
GET /api/v1/apps | Twoje aplikacje OAuth. |
POST /api/v1/apps | Nowa aplikacja. Odpowiedz zawiera client_secret — jedyny raz. |
GET /api/v1/apps/:id | Szczegoly aplikacji. |
PATCH /api/v1/apps/:id | Zmiana nazwy, adresow powrotu, zakresow, statusu. |
POST /api/v1/apps/:id/rotate-secret | Nowy sekret. Stary przestaje dzialac natychmiast. |
GET /api/v1/apps/:id/authorizations | Aktywne zgody — wylacznie pseudonimy i aliasy, bez danych osobowych. |
curl -X POST https://elogowanie.pl/api/v1/apps \
-H "Authorization: Bearer $ELG_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sklep",
"redirect_uris": ["https://sklep.example/callback"],
"scopes": ["openid", "given_name", "age_over_18"],
"client_type": "confidential"
}'
GET /apps/:id/authorizations zwraca sub, alias
i przyznane zakresy — nigdy imienia, adresu ani prawdziwego e-maila.
Dane osobowe pobiera sie wylacznie tokenem konkretnego uzytkownika
przez /oauth2/userinfo.
Weryfikacje dokumentow
| Metoda i sciezka | Opis |
|---|---|
GET /v1/verifications/fields | Pola, o ktore mozna prosic. |
POST /v1/verifications | Nowa sesja. Zwraca adres, na ktory kierujesz uzytkownika. |
GET /v1/verifications/:id | Status i wynik. |
POST /v1/verifications/:id/retry | Nowy adres dla kolejnej proby. |
POST /v1/verifications/:id/cancel | Anulowanie sesji. |
Pelny opis przeplywu, statusow, powodow niepowodzenia i polityki kasowania materialu: dokumentacja weryfikacji.
Bledy
Zawsze JSON o tym samym ksztalcie. Nigdy nie zwracamy sladu stosu.
{ "error": "invalid_scope", "message": "Nieznany zakres: emial" }
| Kod HTTP | Znaczenie |
|---|---|
400 | Blad w zadaniu. Pole error mowi ktory. |
401 | Brak klucza, klucz uniewazniony albo nieprawidlowy. |
404 | Zasob nie istnieje albo nie nalezy do Twojej firmy — nie rozrozniamy tych przypadkow celowo. |
429 | Przekroczony limit zapytan. |
500 | Blad po naszej stronie. Zaloguj u siebie i ponow. |
Limity
Obowiazuje limit zapytan na klucz. Po jego przekroczeniu dostajesz
429. Limity sa dobierane tak, zeby nie przeszkadzaly
normalnej integracji; jesli potrzebujesz wiecej,
napisz do nas zamiast obchodzic limit wieloma kluczami.