Authorize using JWT access token

Using all of API meth­ods requires authen­ti­ca­tion. It is nec­es­sary to have a valid cus­tomer account on the Trans.eu Plat­form. The login and pass­word will be used to obtain the token, which is manda­to­ry to use the API meth­ods.

Initial requirements

Autho­riza­tion using JWT is pos­si­ble only for requests sent using whitelist­ed URL. If no appli­ca­tion URL was added to the whitelist please con­tact api@trans.eu.

Url parameters and connection settings

• Method: GET
• Host: https://auth.platform.trans.eu
• URL: /oauth2/auth
• Para­me­ters: client_id=example_app_client_id
  • response_type=code
  • state=random_number
  • redirect_uri=https://example.com/applicationendpoint
• HTTP/1.1

Diagram

Request parameters (in query string)

The Trans Autho­riza­tion Serv­er will dis­play page with details of request­ed scopes. User has to sign in using Tran.eu cre­den­tials.

Authorization response

When user grants appli­ca­tion access to request­ed scopes, Trans Autho­riza­tion Serv­er will redi­rect user back to URI spec­i­fied in redirect_uri para­me­ter along with gen­er­at­ed code. Exam­ple

• HTTP/1.1 302 Found
• Loca­tion: https://example.com/applicationpoint?code=SDF41D54F54D45DF4

Response parameters

Warn­ing: For secu­ri­ty rea­sons code life­time is lim­it­ed to 1 minute, after that peri­od it becomes invalid. Also please note that not every error will cause a redi­rect. If the request fails due to a miss­ing, invalid, or mis­match­ing redi­rect URI or client id, the Trans Autho­riza­tion Serv­er inform user about this on its own page.

Access token request

After receiv­ing valid code from the Trans Autho­riza­tion Serv­er, appli­ca­tion can make request to the token end­point and exchange code for access token. Exam­ple

• Method: POST
• Host: https://api.platform.trans.eu
• URL: /ex­t/auth-api/ac­counts/­to­ken
• Para­me­ters:
  • grant_type=authorization_code
  • code=a1c94032558c6d0ba98b998299a63135bce063b1
  • redirect_uri=https://example.com/applicationendpoint
  • client_id=example_app_client_id
  • client_secret=example_app_secret
• Head­ers:
  • Con­tent-Type: appli­ca­tion/x‑www-form-urlen­cod­ed
  • Api-key: {unique_ap­p_api-key}

Request parameters

Header parameters

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "access_token": "59d9aa9b15cd59a61fc52014792efb6caa82373b",
  "expires_in": 21599,
  "token_type": "Bearer",
  "scope": "offers.loads.manage",
  "refresh_token": "d52d1d998d6533a3be8e7f26f904be513287938b"
}

Response parameters