Ugrás a fő tartalomra

Platform API hitelesítés (JWT)

A vitalera REST API JWT (JSON Web Token) hitelesítést használ az OAuth 2.0 szabványra alapozva.

Hitelesítő adatok beszerzése​

Lépjen kapcsolatba a support@vitalera.io címmel a következők igényléséhez:

  • Client ID — azonosítja az Ön alkalmazását
  • Client Secret — hitelesíti az Ön alkalmazását
  • Application ID — hitelesítő adatok rotálásához használatos

Client Credentials Grant​

Szerver-szerver (gép-gép) integrációkhoz:

curl -X POST "https://api.vitalera.io/api/auth/tokens/" \
     -H "Content-Type: application/json" \
     -d '{
           "grant_type": "client_credentials",
           "client_id": "<CLIENT_ID>",
           "client_secret": "<CLIENT_SECRET>"
         }'

Válasz:

{
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "Bearer",
  "expires_in": 3600
}

Password Grant​

Felhasználói bejelentkezési folyamatokhoz (pl. mobil- vagy webalkalmazások, amelyek egyéni felhasználókat hitelesítenek):

curl -X POST "https://api.vitalera.io/api/auth/tokens/" \
     -H "Content-Type: application/json" \
     -d '{
           "grant_type": "password",
           "username": "<USERNAME>",
           "password": "<PASSWORD>"
         }'

Válasz:

{
  "id_token": "<ID_TOKEN>",
  "access_token": "<ACCESS_TOKEN>",
  "refresh_token": "<REFRESH_TOKEN>",
  "sub": "<USER_ID>"
}

API-kérések indítása​

Minden kérés Authorization fejlécébe foglalja bele a hozzáférési tokent:

curl -X GET "https://api.vitalera.io/api/plans/" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Token érvényessége​

A hozzáférési tokenek 1 óráig (3600 másodperc) érvényesek. Amikor egy token lejár, az API HTTP 401 Unauthorized választ ad:

{
  "errors": [
    {
      "errorType": "expired_token",
      "message": "Access token expired"
    }
  ]
}

Token frissítés​

Ha refresh tokent kapott (jelszó alapú jogosultságkéréssel), frissítheti a hozzáférési tokent újrahitelesítés nélkül:

curl -X POST "https://api.vitalera.io/api/auth/tokens/refresh/" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
           "refresh_token": "<REFRESH_TOKEN>"
         }'

Token érvényesítés​

Ellenőrizze, hogy egy token még érvényes-e:

curl -X GET "https://api.vitalera.io/api/auth/tokens/validate/" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Hitelesítő adatok rotálása​

Biztonsági okokból rendszeresen rotálja ügyfél-hitelesítő adatait. Ehhez érvényes JWT és az application_id szükséges:

curl -X POST "https://api.vitalera.io/api/applications/rotate_credentials/" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
           "application_id": "<APPLICATION_ID>"
         }'

Válasz:

{
  "id": "<APPLICATION_ID>",
  "name": "TestApp",
  "organization": "123",
  "client_id": "<NEW_CLIENT_ID>",
  "client_secret": "<NEW_CLIENT_SECRET>",
  "application_types": ["API"]
}

Rotálás után az előző hitelesítő adatok azonnal érvénytelenné válnak.

Segítségre van szüksége?​

Lépjen kapcsolatba a support@vitalera.io címmel hitelesítési beállítási segítségért.