Authentication

The Ship.Cars API uses OAuth2 to authenticate requests from external applications.

AccessToken

Security scheme type: OAuth2 - password OAuth Flow

• Token URL: https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token
• Scopes
  • write - read and write access to resources associated with your company

Example request for getting access token

curl --location --request POST 'https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=<<client_id>>' \
--data-urlencode 'client_secret=<<client_secret>>' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=<<username>>' \
--data-urlencode 'password=<<password>>'

The values of client_id and client_secret are the credentials for your registered client application, and username and password are the credentials for the registered user from your client application.

The response to your POST request will contain a JSON body with your access token details:

{
    "access_token": "<<access_token>>",
    "expires_in": 1314000,
    "refresh_expires_in": 1800,
    "refresh_token": "<<refresh_token>>",
    "token_type": "Bearer",
    "not-before-policy": 0,
    "session_state": "97c63c02-a267-4814-8e1c-8b2d958ca61d",
    "scope": "email profile"
}

To authenticate your requests to API resources, add the following Authorization header to all your requests:

"Authorization: Bearer <<access_token>>"