From 213f937c5ddea95b5d122de830688c6da30e032f Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 1 Nov 2022 10:55:00 +0000 Subject: [PATCH] spec release --- json/TfmAPIService-v1.json | 4 ++-- yaml/TfmAPIService-v1.yaml | 10 ++++++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/json/TfmAPIService-v1.json b/json/TfmAPIService-v1.json index d17e745..b7b017a 100644 --- a/json/TfmAPIService-v1.json +++ b/json/TfmAPIService-v1.json @@ -9,8 +9,8 @@ "version" : "1", "x-publicVersion" : true, "title" : "POS Terminal Management API", - "description" : "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api).\n\n## Authentication\nEach request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_API_key\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nTerminal Management 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://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```", - "x-timestamp" : "2022-08-15T11:22:35Z", + "description" : "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api).\n\n## Authentication\nEach request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_API_key\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nTerminal Management 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://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```\nWhen using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`.\nIf you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`.", + "x-timestamp" : "2022-10-31T10:21:01Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/yaml/TfmAPIService-v1.yaml b/yaml/TfmAPIService-v1.yaml index 8e7cfb8..efc7dbb 100644 --- a/yaml/TfmAPIService-v1.yaml +++ b/yaml/TfmAPIService-v1.yaml @@ -51,8 +51,14 @@ info: https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount - ```' - x-timestamp: '2022-08-15T11:22:35Z' + ``` + + When using versioned endpoints, Boolean response values are returned in string + format: `"true"` or `"false"`. + + If you omit the version from the endpoint URL, Boolean response values are returned + like this: `true` or `false`.' + x-timestamp: '2022-10-31T10:21:01Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team