![\"IATE2](\"https://s3.eu-central-1.amazonaws.com/iate2-api/api_doc_cover.png\")
IATE2 Auth API. Here are some pre-made requests for you to explore the API using Postman.
\nYou'll need your API keys, so contact iate@cdt.europa.eu if you don't have them.
\nThere is a username and password that should be used for signing every private request.
Take care of your password:
IATE2 API is using OAuth 2.0 authorization framework + OpenID Connect authentication layer.
Before accessing IATE2 private API you have to log-in with the provided credentials in order to get the IdToken, AccessToken and RefreshToken.
The IdToken and AccessToken pair expires in 3 hours, this is why you have to refresh it before it expires using the RefreshToken.\nThe RefreshToken also expires in 12 hours, after that you have to login again with the provided credentials.\nEvery time you refresh the IdToken and AccessToken pair you are getting automatically a new RefreshToken.
Every private request should contain the AccessToken in the Authorization header:
Authorization: Bearer AccessToken
If you have any questions or comments, please let us know at iate@cdt.europa.eu.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Keys","slug":"api-keys"},{"content":"Signing your request","slug":"signing-your-request"},{"content":"Questions/Comments/Suggestions","slug":"questionscommentssuggestions"}],"owner":"4028985","collectionId":"005ff078-3572-48c1-8685-428e036aff97","publishedId":"S1Lr2pzQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-04-29T11:57:16.000Z"},"item":[{"name":"Authentification","item":[{"name":"V1","item":[{"name":"Get Token","id":"407be5ff-1b39-4e98-aea1-e8145166434d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/vnd.iate.token+json; version=1","description":"The version 1 of the API token
\n"},{"description":"Must always be 'application/x-www-form-urlencoded'
\n","key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"/oauth2/token?grant_type=password&username=someusername&password=somepassword","description":"Generates AccessToken and RefreshToken.
The AccessToken should be used for signing all the private requests.
The RefreshToken should be used for extending the AccessToken.
200 OK400 Bad Request500 Internal Server Error - If there is a backend issueThe AccessToken value should be extracted from:
\"tokens\": [\"<YOUR-JWT-ACCESS-TOKEN>\"]\nThe RefreshToken value should be extracted from:
\"refresh_token\": \"<YOUR-JWT-REFRESH-TOKEN>\"\nThe permission_name_by_id the lookup map of the permission by the id referenced in the access token.
The role_group_name_by_id the lookup map of the role group name by the id referenced in the access token.
Must always be 'password', Resource Owner Password Credentials Grant
\n","type":"text/plain"},"key":"grant_type","value":"password"},{"description":{"content":"The API username
\n","type":"text/plain"},"key":"username","value":"someusername"},{"description":{"content":"The API password
\n","type":"text/plain"},"key":"password","value":"somepassword"}],"variable":[]}},"response":[{"id":"070ec9a5-a05b-41be-a0a2-48b629dac8ec","name":"Prod -> Get Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.iate.token+json; version=1","description":"The version 1 of the API token","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'","type":"text"}],"url":{"raw":"https://iate.europa.eu/uac-api/oauth2/token?username=someuser&password=somepassword&grant_type=password","protocol":"https","host":["iate","europa","eu"],"path":["uac-api","oauth2","token"],"query":[{"key":"username","value":"someuser","description":"The API username"},{"key":"password","value":"somepassword","description":"The API password"},{"key":"grant_type","value":"password","description":"Must always be 'password'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Feb 2019 15:38:15 GMT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,If-Modified-Since,Cache-Control,Pragma"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Length","value":"0"},{"key":"Content-Type","value":"application/vnd.iate.token+json; version=1"},{"key":"Cache-Control","value":"proxy-revalidate"},{"key":"Server","value":"Europa"},{"key":"Connection","value":"Keep-Alive"},{"key":"Proxy-support","value":"Session-based-authentication"}],"cookie":[],"responseTime":null,"body":"{ \r\n \"token_type\":\"bearer\",\r\n \"tokens\":[ \r\n \"The version 1 of the API token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'
\n","type":"text"}],"url":"/oauth2/token?refresh_token=somevalue&grant_type=refresh_token","description":"Generates a new AccessToken and RefreshToken based on the previous RefreshToken.
200 OK400 Bad Request500 Internal Server Error - If there is a backend issuerefresh_token (string, required) - The RefreshToken provided by IATE2 Get Access Token EndpointThe new AccessToken value should be extracted from:
\"tokens\": [\"<YOUR-JWT-ACCESS-TOKEN>\"]\nThe new RefreshToken value should be extracted from:
\"refresh_token\": \"<YOUR-JWT-REFRESH-TOKEN>\"\nThe permission_name_by_id the lookup map of the permission by the id referenced in the access token.
The role_group_name_by_id the lookup map of the role group name by the id referenced in the access token.
The API refresh token
\n","type":"text/plain"},"key":"refresh_token","value":"somevalue"},{"description":{"content":"Must always be 'refresh_token', Refresh Token Grant
\n","type":"text/plain"},"key":"grant_type","value":"refresh_token"}],"variable":[]}},"response":[{"id":"6fbfd106-4b6c-4bc6-a903-a3133a3a259f","name":"Test -> Extends Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.iate.token+json; version=1","description":"The version 1 of the API token","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'","type":"text"}],"url":{"raw":"https://test.iate2.eu/uac-api/ws/oauth2/token?refresh_token=somevalue&grant_type=refresh_token","protocol":"https","host":["test","iate2","eu"],"path":["uac-api","ws","oauth2","token"],"query":[{"key":"refresh_token","value":"somevalue","description":"The API refresh token"},{"key":"grant_type","value":"refresh_token","description":"Must always be 'refresh_token'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Feb 2019 15:38:15 GMT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,If-Modified-Since,Cache-Control,Pragma"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Length","value":"0"},{"key":"Content-Type","value":"application/vnd.iate.token+json; version=1"},{"key":"Cache-Control","value":"proxy-revalidate"},{"key":"Server","value":"Europa"},{"key":"Connection","value":"Keep-Alive"},{"key":"Proxy-support","value":"Session-based-authentication"}],"cookie":[],"responseTime":null,"body":"{ \r\n \"token_type\":\"bearer\",\r\n \"tokens\":[ \r\n \"In this folder, you will find the endpoints for V1.
\nAll the new customers have to use the latest version.
\n","event":[{"listen":"prerequest","script":{"id":"0112f2be-8a47-47c4-aa76-7e796afccdf8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a272183e-9b72-48b0-b3ac-fcf8f2792f19","type":"text/javascript","exec":[""]}}],"_postman_id":"4b31e53b-2d29-41dc-85d2-bcf5b6a4f719"},{"name":"V2","item":[{"name":"Get Token","id":"a6a26985-c461-4a8e-a2ad-f7636088ef6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/vnd.iate.token+json; version=2","description":"The version 2 of the API token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'
\n","type":"text"}],"url":"/oauth2/token?grant_type=password&username=someusername&password=somepassword","description":"Generates IdToken, AccessToken and RefreshToken.
The IdToken should be used by client applications. The ID Token is a JSON Web Token (JWT) that contains user profile information (such as the user's name, email, permission roles, etc.) which is represented in the form of claims. These claims are statements about the user.
The AccessToken should be used for signing all the private requests.
The RefreshToken should be used for extending the AccessToken.
200 OK400 Bad Request500 Internal Server Error - If there is a backend issueThe IdToken value should be extracted from:
\"tokens.id_token\": [\"<YOUR-JWT-ID-TOKEN>\"]\nThe AccessToken value should be extracted from:
\"tokens.access_token\": [\"<YOUR-JWT-ACCESS-TOKEN>\"]\nThe RefreshToken value should be extracted from:
\"refresh_token\": \"<YOUR-JWT-REFRESH-TOKEN>\"\nMust always be 'password', Resource Owner Password Credentials Grant
\n","type":"text/plain"},"key":"grant_type","value":"password"},{"description":{"content":"The API username
\n","type":"text/plain"},"key":"username","value":"someusername"},{"description":{"content":"The API password
\n","type":"text/plain"},"key":"password","value":"somepassword"}],"variable":[]}},"response":[{"id":"738112d6-639d-4485-baef-7e97c871a73d","name":"Prod -> Get Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.iate.token+json; version=2","description":"The version 2 of the API token","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'","type":"text"}],"url":{"raw":"https://iate.europa.eu/uac-api/oauth2/token?username=someusername&password=somepassword&grant_type=password","protocol":"https","host":["iate","europa","eu"],"path":["uac-api","oauth2","token"],"query":[{"key":"username","value":"someusername","description":"The API username"},{"key":"password","value":"somepassword","description":"The API password"},{"key":"grant_type","value":"password","description":"Must always be 'password'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Feb 2019 15:38:15 GMT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,If-Modified-Since,Cache-Control,Pragma"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Length","value":"0"},{"key":"Content-Type","value":"application/vnd.iate.token+json; version=2"},{"key":"Cache-Control","value":"proxy-revalidate"},{"key":"Server","value":"Europa"},{"key":"Connection","value":"Keep-Alive"},{"key":"Proxy-support","value":"Session-based-authentication"}],"cookie":[],"responseTime":null,"body":"{ \r\n \"token_type\":\"bearer\",\r\n \"tokens\":[ \r\n { \r\n \"id_token\":\"The version 2 of the API token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'
\n","type":"text"}],"url":"/oauth2/token?refresh_token=somevalue&grant_type=refresh_token","description":"Generates a new IdToken, AccessToken and RefreshToken based on the previous RefreshToken.
200 OK400 Bad Request500 Internal Server Error - If there is a backend issuerefresh_token (string, required) - The RefreshToken provided by IATE2 Get Access Token EndpointThe IdToken value should be extracted from:
\"tokens.id_token\": [\"<YOUR-JWT-ID-TOKEN>\"]\nThe AccessToken value should be extracted from:
\"tokens.access_token\": [\"<YOUR-JWT-ACCESS-TOKEN>\"]\nThe RefreshToken value should be extracted from:
\"refresh_token\": \"<YOUR-JWT-REFRESH-TOKEN>\"\nThe API refresh token
\n","type":"text/plain"},"key":"refresh_token","value":"somevalue"},{"description":{"content":"Must always be 'refresh_token', Refresh Token Grant
\n","type":"text/plain"},"key":"grant_type","value":"refresh_token"}],"variable":[]}},"response":[{"id":"2ecdac24-deaa-4da5-be0a-e122cfe32502","name":"Prod -> Extends Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.iate.token+json; version=2","description":"The version 2 of the API token","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Must always be 'application/x-www-form-urlencoded'","type":"text"}],"url":{"raw":"https://iate.europa.eu/uac-api/oauth2/token?refresh_token=somevalue&grant_type=refresh_token","protocol":"https","host":["iate","europa","eu"],"path":["uac-api","oauth2","token"],"query":[{"key":"refresh_token","value":"somevalue","description":"The API refresh token"},{"key":"grant_type","value":"refresh_token","description":"Must always be 'refresh_token'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Feb 2019 15:38:15 GMT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,If-Modified-Since,Cache-Control,Pragma"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT, PATCH,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Length","value":"0"},{"key":"Content-Type","value":"application/vnd.iate.token+json; version=2"},{"key":"Cache-Control","value":"proxy-revalidate"},{"key":"Server","value":"Europa"},{"key":"Connection","value":"Keep-Alive"},{"key":"Proxy-support","value":"Session-based-authentication"}],"cookie":[],"responseTime":null,"body":"{ \r\n \"token_type\":\"bearer\",\r\n \"tokens\":[ \r\n { \r\n \"id_token\":\"In this folder, you will find the endpoints for V2.
\nCurrently, this is the latest version of auth tokens.
\n","event":[{"listen":"prerequest","script":{"id":"0112f2be-8a47-47c4-aa76-7e796afccdf8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a272183e-9b72-48b0-b3ac-fcf8f2792f19","type":"text/javascript","exec":[""]}}],"_postman_id":"8c3703a7-4c65-4ed3-99f2-d462f106ed79"}],"id":"455b6967-e1f9-41b7-a2b2-fa3b64823b38","description":"In this folder, you will find the endpoints for IdToken, AccessToken and RefreshToken management.
Every private request should contain the AccessToken in the Authorization header:
Authorization: Bearer AccessToken
Currently, we are supporting two versions of auth tokens.
\nThe versioning is implemented via custom media types.
\nV1 : application/vnd.iate.token+json; version=1
V2 : application/vnd.iate.token+json; version=2