From 02848d0ca7d94dba777fff3d8388692e10567f0f Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 16 Oct 2024 09:43:41 +0200 Subject: [PATCH] spec release --- json/SessionAuthenticationService-v1.json | 9 ++++++++- yaml/SessionAuthenticationService-v1.yaml | 7 ++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/json/SessionAuthenticationService-v1.json b/json/SessionAuthenticationService-v1.json index 673807c5..60c34d66 100644 --- a/json/SessionAuthenticationService-v1.json +++ b/json/SessionAuthenticationService-v1.json @@ -1,5 +1,12 @@ { "openapi" : "3.1.0", + "servers" : [ { + "url" : "https://authe-live.adyen.com/v1", + "description" : "Live Environment" + }, { + "url" : "https://test.adyen.com/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", @@ -9,7 +16,7 @@ "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "1", - "x-timestamp" : "2024-10-10T11:32:26Z" + "x-timestamp" : "2024-10-14T20:29:10Z" }, "tags" : [ { "name" : "Session authentication" diff --git a/yaml/SessionAuthenticationService-v1.yaml b/yaml/SessionAuthenticationService-v1.yaml index c7f85cf4..74922681 100644 --- a/yaml/SessionAuthenticationService-v1.yaml +++ b/yaml/SessionAuthenticationService-v1.yaml @@ -1,4 +1,9 @@ openapi: 3.1.0 +servers: +- url: https://authe-live.adyen.com/v1 + description: Live Environment +- url: https://test.adyen.com/v1 + description: Test Environment info: title: Session authentication API description: "The Session authentication API enables you to create and manage the\ @@ -29,7 +34,7 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '1' - x-timestamp: '2024-10-10T11:32:26Z' + x-timestamp: '2024-10-14T20:29:10Z' tags: - name: Session authentication paths: