jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2024-10-17 10:49:28 +02:00
parent 02848d0ca7
commit eb07e10f3c
2 changed files with 12 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
json/SessionAuthenticationService-v1.json
View File

@@ -1,22 +1,22 @@
{
"openapi" : "3.1.0",
"servers" : [ {
"url" : "https://authe-live.adyen.com/v1",
"url" : "https://authe-live.adyen.com/authe/api/v1",
"description" : "Live Environment"
}, {
"url" : "https://test.adyen.com/v1",
"url" : "https://test.adyen.com/authe/api/v1",
"description" : "Test Environment"
} ],
"info" : {
"title" : "Session authentication API",
"description" : "The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating [components](https://docs.adyen.com/platforms/components-overview).\n## Authentication\nWe recommend that you use an API key to connect to the Session authentication API. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key). If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the Session authentication API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H 'Content-Type: application/json' \\\n-H 'X-API-Key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY' \\\n...\n```\n\n## Roles and permissions\nTo create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for [Onboarding](https://docs.adyen.com/platforms/onboard-users/components) and [Platform Experience](https://docs.adyen.com/platforms/build-user-dashboards) components.\n\n## Versioning\nThe Session authentication API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://test.adyen.com/authe/api/v1/sessions\n```\n## Going live\nTo access the live endpoint, generate an API key in your live Customer Area if you have a [platform](https://docs.adyen.com/platforms/) or [marketplace setup](https://docs.adyen.com/marketplaces/). If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area. You can then use the API key to send requests to `https://authe-live.adyen.com/authe/api/v1`.\n\n",
"description" : "The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating [components](https://docs.adyen.com/platforms/components-overview).\n## Authentication\nWe recommend that you use an API key to connect to the Session authentication API. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key). If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the Session authentication API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H 'Content-Type: application/json' \\\n-H 'X-API-Key: YOUR_API_KEY' \\\n...\n```\n\n## Roles and permissions\nTo create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for [Onboarding](https://docs.adyen.com/platforms/onboard-users/components) and [Platform Experience](https://docs.adyen.com/platforms/build-user-dashboards) components.\n\n## Going live\nTo access the live endpoint, generate an API key in your live Customer Area if you have a [platform](https://docs.adyen.com/platforms/) or [marketplace setup](https://docs.adyen.com/marketplaces/). If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area. You can then use the API key to send requests to `https://authe-live.adyen.com/authe/api/v1`.\n\n",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://github.com/Adyen/adyen-openapi"
},
"version" : "1",
"x-timestamp" : "2024-10-14T20:29:10Z"
"x-timestamp" : "2024-10-17T10:29:09Z"
},
"tags" : [ {
"name" : "Session authentication"

19
yaml/SessionAuthenticationService-v1.yaml
View File

@@ -1,8 +1,8 @@
openapi: 3.1.0
servers:
- url: https://authe-live.adyen.com/v1
- url: https://authe-live.adyen.com/authe/api/v1
description: Live Environment
- url: https://test.adyen.com/v1
- url: https://test.adyen.com/authe/api/v1
description: Test Environment
info:
title: Session authentication API
@@ -15,18 +15,15 @@ info:
\ If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
\ in your Balance Platform Customer Area.\n\nTo connect to the Session authentication\
\ API, add an `X-API-Key` header with the API key as the value, for example:\n\
\n ```\ncurl\n-H 'Content-Type: application/json' \\\n-H 'X-API-Key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY'\
\n ```\ncurl\n-H 'Content-Type: application/json' \\\n-H 'X-API-Key: YOUR_API_KEY'\
\ \\\n...\n```\n\n## Roles and permissions\nTo create a token, you must meet specific\
\ requirements. These requirements vary depending on the type of component. For\
\ more information, see the documentation for [Onboarding](https://docs.adyen.com/platforms/onboard-users/components)\
\ and [Platform Experience](https://docs.adyen.com/platforms/build-user-dashboards)\
\ components.\n\n## Versioning\nThe Session authentication API supports [versioning](https://docs.adyen.com/development-resources/versioning)\
\ using a version suffix in the endpoint URL. This suffix has the following format:\
\ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://test.adyen.com/authe/api/v1/sessions\n\
```\n## Going live\nTo access the live endpoint, generate an API key in your live\
\ Customer Area if you have a [platform](https://docs.adyen.com/platforms/) or\
\ [marketplace setup](https://docs.adyen.com/marketplaces/). If you have an Adyen\
\ Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
\ components.\n\n## Going live\nTo access the live endpoint, generate an API key\
\ in your live Customer Area if you have a [platform](https://docs.adyen.com/platforms/)\
\ or [marketplace setup](https://docs.adyen.com/marketplaces/). If you have an\
\ Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
\ in your Balance Platform Customer Area. You can then use the API key to send\
\ requests to `https://authe-live.adyen.com/authe/api/v1`.\n\n"
termsOfService: https://www.adyen.com/legal/terms-and-conditions
@@ -34,7 +31,7 @@ info:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
version: '1'
x-timestamp: '2024-10-14T20:29:10Z'
x-timestamp: '2024-10-17T10:29:09Z'
tags:
- name: Session authentication
paths: