ReportService_automaticdata

How to use an Access Token

Example access token

POST to https://services.cabmandata.com/authentication/connect/token with form-data or x-www-form-urlencoded in the body:

- grant_type: password
- username: <username>
- password: <password>
- client_id: ExternalClient

Example urlencoded:

POST /authentication/connect/token HTTP/1.1 Host: services.cabmandata.com Accept: application/json Content-Type: application/
x-www-form-urlencoded grant_type=password&username=<username>&password=<password>&client_id=ExternalClient

curl --location --request POST 'https://services.cabmandata.com/authentication/connect/token' \ --header 'Accept: application/json' 
\ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=password' \ --data-urlencode 
'username=<username>' \ --data-urlencode 'password=<password>' \ --data-urlencode 'client_id=ExternalClient'

var settings = {   "url": "https://services.cabmandata.com/authentication/connect/token",   "method": "POST",   "timeout": 0,   
"headers": {     "Accept": "application/json",     "Content-Type": "application/x-www-form-urlencoded"   },   "data": 
{     "grant_type": "password",     "username": "<username>",     "password": "<password>",     "client_id": "ExternalClient"   } };
  $.ajax(settings).done(function (response) {   console.log(response); });

Access token

{ "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjlGNzdCRDEwRkUzMDYyQ0U1OTMyM0ExQ0JFNjlGQ0MyRURBNTg0MjEiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJuM2U
5RVA0d1lzNVpNam9jdm1uOHd1MmxoQ0UifQ.eyJuYmYiOjE1OTA3NDk2OTEsImV4cCI6MTU5MzM0MTY5MSwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMiIsImF1ZCI6Wy
JodHRwczovL2xvY2FsaG9zdDo1MDAyL3Jlc291cmNlcyIsInJlcG9ydHNlcnZpY2VfYXBpIl0sImNsaWVudF9pZCI6IkV4dGVybmFsQ2xpZW50Iiwic3ViIjoiMDc2YTFlNjMt
NDdiYS00M2EzLWIyNTktZDg4ZjVlMjZlZThjIiwiYXV0aF90aW1lIjoxNTkwNzQ5NjkxLCJpZHAiOiJsb2NhbCIsImxvY2FsZSI6Im5sLU5MIiwiZW1haWwiOiJqLnZvbGtlcm
luZ0BldXBob3JpYS1pdC5ubCIsImVtYWlsX3ZlcmlmaWVkIjoidHJ1ZSIsIm5hbWUiOiJsb2NhbHRheCIsImN1c3RvbWVya2V5IjoiMiIsInVzZXJtYW5hZ2VtZW50IjoiMSIs
InNjb3BlIjpbIm9wZW5pZCIsInJlcG9ydHNlcnZpY2VfYXBpIiwib2ZmbGluZV9hY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.DmYfID74gMa9OAFVglqncMpWALrqtnqFCwsX8T_
M8oDVL9YwHAA8e9lj5WTnH8ouvhjEr1e6o4t2LQ60TTyai3JK-GUJ4iDl72_wFPxSJdiRMa4xaq_1Xk_0ciVl22vyw8oldcXFK8gxu_tNaDVXXvxkwE50hCeaPYoFy03SYSfGL
Wlv_yw1tnYmr_TMPfj3UICtoJ2epUIqkmjg_F0nhITIpFtpNRolfgcJG5-6fTioegKCujlBOqZtSRBhlMXfPxz190bh42NK7phk___XndZISRMu6owdWugcpgMsuCJpZII7Oz5
4TwTThpw6gi9P3BLUzpkV27-DqoGymRoENBi36mIPMnhUyZE7ku18aVxcxwvER5EinCrPdqSlhgHUTtAfgSgl7jHRFmJa_e7No-PoCiMaFJJDEeJl7-goFjHiuTeuIwojqKLzj
cnvKzqZ8Z30ovrwAT7bXblYIMLrWw69GTKAILjANUwJee6i-hGkLZFD36c4Z-Qdto1cSxKkFB9Cim3fTxMD83WBD_CkKDKK3LDLwPXQwsEK6-zUBAAVjTxDajSHbC-q-CxE0H_
MesEzeTeGBIUZ3ZoM_crhGURZRp8Qjtq_7u5RLa768x235umOOFSiDCvmP1S0XNKkX7YqPJlQJ-ZLLuk3N4ry0Hpe4VxaJ3VYe4etiQa5PZw", "expires_in": 2592000, 
"token_type": "Bearer", "refresh_token": "ec1539159f4a55fa2263525f80b408685aa8c35a2ff41f1cc7557c82749fb357", "scope": "offline_access 
openid reportservice_api" }

When there is a username/password combination and the client is valid a JSON response will be returned including an access_token. In the response it is indicated how long the token will be valid. Periodically refresh the access_token using the provided refresh_token. In case a request is invalid, an error will be returned.

How to use a Refresh token

With a refresh_token a new combination of access_token and refresh_token can be requested. We advise to remain access until the token is expired permanently. Usually an acces_token is valid for an hour. During the change in this period, the token will be extended to one month. After this transmission the expiration date will be set to the standard. After then it is necessary to request through the refresh_token a new token to keep access with the service. In practice, this will mean that a new access_token needs to be requested upon requesting for a report.

A refresh_token is valid for 15 days. You can only refresh an access_token through a refresh_token within one month. After this you will need to authenticate again.

A new access_token can be requested through a refresh_token en is similar to authentication, except the fields will be different in the body.

Example refresh token

POST /authentication/connect/token HTTP/1.1 Host: services.cabmandata.com Accept: application/json Content-Type: application
/x-www-form-urlencoded grant_type=refresh_token&client_id=ExternalClient&refresh_token=ec1539159f4a55fa2263525f80b408685aa8c
35a2ff41f1cc7557c82749fb357

var settings = {   "url": "https://services.cabmandata.com/authentication/connect/token",   "method": "POST",   "timeout": 0,
   "headers": {     "Accept": "application/json",     "Content-Type": "application/x-www-form-urlencoded"   },   "data": 
{     "grant_type": "refresh_token",     "refresh_token": "ec1539159f4a55fa2263525f80b408685aa8c35a2ff41f1cc7557c82749fb357",
     "client_id": "ExternalClient"   } };  $.ajax(settings).done(function (response) {   console.log(response); });

A response when a token is valid is displayed below. The token is invalid when a status 401 is returned. In the response there is a new refresh_token in which an access_token can be requested with the next interval.

Refresh token

{ "id_token":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjlGNzdCRDEwRkUzMDYyQ0U1OTMyM0ExQ0JFNjlGQ0MyRURBNTg0MjEiLCJ0eXAiOiJKV1QiLCJ4NXQiOi
JuM2U5RVA0d1lzNVpNam9jdm1uOHd1MmxoQ0UifQ.eyJuYmYiOjE1OTA3NTA5NjMsImV4cCI6MTU5MDc1MTI2MywiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTA
wMiIsImF1ZCI6IkV4dGVybmFsQ2xpZW50IiwiaWF0IjoxNTkwNzUwOTYzLCJhdF9oYXNoIjoick0wQWgteWs5TVYyWGJ4Q2FRa29TdyIsInN1YiI6IjA3NmExZTY
zLTQ3YmEtNDNhMy1iMjU5LWQ4OGY1ZTI2ZWU4YyIsImF1dGhfdGltZSI6MTU5MDc0OTY5MSwiaWRwIjoibG9jYWwiLCJhbXIiOlsicHdkIl19.J4S2-vQ1Od8BJ0
jrY_9Y5NQKCSiwyyrAIu_v79AoPLzgo0QVSMGecI1l9dh-PdiP6xm16zNOPbNl7inPhm_QjHikjG2E46LzfTDz2PfGFHzAot4zCjgomqfmSHCjq00TNyeSnfqnSD
JQvPdJNxovcOhNf9MOaoT7S8Z11XWAuchKmX89WYzGuKjfXa2zHm9TVw1bA_DaItP8o4asYM0PZuSBAf1zsO2gXzEH1weOPb6gYGWSLUBodmbW6IP0lvzozZUEbo
HI2ML4VDWsNww8DZQ7Tk2IRfH7xk0tKs6Ca4o4btT0Wo9mD6f1m4Ehrhh2TCSJilgyUotXUA0QBlmWPcRqWj6nhJrNZO9CX8yDsiW7YUmjnQ8A2fFCJWXzUZX-ME
RhekvRuPWjTCGOHD5FCqdJNCNu4jWWo2VjpHRx6CB74pZVaTk7-EfimddqZMH98cmJ81UE__hCxBvsM5Nb_dDqYMHDt2rxT7rvZLgvwytNdCH5rScxGfBJi5y3ux
LG44jIXKgd1gfQBP3ED0C1FP2FzcwpHlGC7zYrhUbvNgQY4GJIEkfz0Vm-Ew7Jvz1iJbuzT5Gy6i294f6g2cSMr_jXrNoqih67tl6gbBNHOBlMrVGUOqBfAWkBjs
WSqY9JdNeae58RDjxM_9Q4m6JeJpTdcTbVVgBb5OFnQ6eSmiA", "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjlGNzdCRDEwRkUzMDYyQ0U1OTM
yM0ExQ0JFNjlGQ0MyRURBNTg0MjEiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJuM2U5RVA0d1lzNVpNam9jdm1uOHd1MmxoQ0UifQ.eyJuYmYiOjE1OTA3NTA5NjMsImV4
cCI6MTU5MzM0Mjk2MywiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NTAwMiIsImF1ZCI6WyJodHRwczovL2xvY2FsaG9zdDo1MDAyL3Jlc291cmNlcyIsInJlcG9y
dHNlcnZpY2VfYXBpIl0sImNsaWVudF9pZCI6IkV4dGVybmFsQ2xpZW50Iiwic3ViIjoiMDc2YTFlNjMtNDdiYS00M2EzLWIyNTktZDg4ZjVlMjZlZThjIiwiYXV0
aF90aW1lIjoxNTkwNzQ5NjkxLCJpZHAiOiJsb2NhbCIsImxvY2FsZSI6Im5sLU5MIiwiZW1haWwiOiJqLnZvbGtlcmluZ0BldXBob3JpYS1pdC5ubCIsImVtYWls
X3ZlcmlmaWVkIjoidHJ1ZSIsIm5hbWUiOiJsb2NhbHRheCIsImN1c3RvbWVya2V5IjoiMiIsInVzZXJtYW5hZ2VtZW50IjoiMSIsInNjb3BlIjpbIm9wZW5pZCIs
InJlcG9ydHNlcnZpY2VfYXBpIiwib2ZmbGluZV9hY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.TuCJtTgGYi6pno3kaxHAMLzvqocY2xR32V10yELpxST81wPdiqXTL
tBDX4PL2B13NgW_1RLQd_H7XoecAeriwl3N5mCzm3jLK498_Uu7vspD7MimBFziYs7KX1iMBP1Ac8cqU5rjB9cXNEpb1q3K8e2zNZylsHLf70VfbeBFI-suEyXu0
v_WyIRu1LzXBY78fHCUKS9qGRh9KcES-pNlfCnYvAkTIkrGAbWnyjnexpKPU-rgqXIWt34KZptFxYn7-a4D7FGJ7UG2cd4SOQ9lbSpeOr99epMntyRFZmwPAv7QT
CSrLF_z4Nvk96gCJ-LjE9oFFxaxMmFWgp3ji4cLrBRAVs-7zmxXxgtEAUyoSBKKm1gA-DAI0gZEEJhuKTMKope7JD1VVLtRfSEY1JUX0L7d2diNUXCiZNJpB_0_3
yF6qJQUv_K3a5DyefVBFHNnLnGX1T8PD0JkgBDERZ9JqnxymbAvmMIc-SaQ9l76IBE2K3IDUOl3etKbVVcOcBHpHzFF2KLtjQ-C5UbesrDSzYv2g_TB3R0TyNHdk
GKVse7caxOurhS6VfiyWR7zhFesuF6rbVYjKTScI5Vy4c84q4sQKe_0FA87KpIx-vaKdHpxcZ9waqTRqnyTCBwB0lQbeX9jngBJIgBcp6k3u0M3H1nugfzJ_FOYm
3Ltkvoqnlg", "expires_in": 2592000, "token_type": "Bearer", "refresh_token": "e643bea2210c1e1d5eb50364fe7ac485e288ecd33376fd
5c72ee192870fc172c", "scope": "openid reportservice_api offline_access" }

How to use the documentation

Instructions

How to use an Access Token

How to use a Refresh token

Full request