Uwierzytelnianie oraz autoryzacja oparte są na protokole OAuth 2.0. Wyróżniamy dwie metody uwierzytelnienia - aplikacji oraz użytkownika. W obu przypadkach zwracany jest access_token, który umożliwia dalsze korzystanie z REST API.

Uwierzytelnianie aplikacji

@todo To jest jeszcze niezrobione.

Uwierzytelnianie użytkownika

Aby uzyskać access_token należy przesłać metodą POST na adres URL:

  • API obsługujące konta pracowników: https://api.respondo.pl/rest/token
  • API obsługujące konta klientów: https://api.client.respondo.pl/rest/token

Następujące parametry:

  • grant_type - w tym przypadku z wartością password
  • client_id - ID aplikacji
  • username - nazwa użytkownika
  • password - hasło użytkownika

Przykładowe wywołanie

curl -H "Content-Type: application/json" -X POST -d '{"grant_type":"password","client_id":"respondo","username":"name@domain.pl","password":"test1234"}' https://api.respondo.pl/rest/token

Zwracane dane

{
    "access_token": "c4de8be8a0b78babee55957be988ae9d7e24f25f",
    "expires_in": 600,
    "token_type": "Bearer",
    "scope": null,
    "refresh_token": "56c9d7da53012bc7e41e0a03137c217cf3cf379a",
    "user_id": "135",
    "UserRole": {
        "id": null,
        "customer_id": null,
        "name": null,
        "created": null,
        "modified": null
    },
    "UserRolePermission": [],
    "UserPermission": []
}

Przekazywanie access_token w żądaniu

access_token powinien być przekazywany w nagłówku żądania w następujący sposób:

Authorization: Bearer acff287fd94a1aa63d0e6610b0846b83b1b08cc3