Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Sep 9, 2024
1 parent e812f37 commit 8f753c0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion json/TfmAPIService-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"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 [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).\n\n>POS Terminal Management API will soon be deprecated. To automate the management of your terminal fleet, we recommend you use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).\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## Roles and permissions\nTo use the POS Terminal Management API, you need the **POS Terminal Management API role** added to your API credential. Your Adyen contact will set up the roles for you.\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`.\n## Going live\nTo access the live endpoints, you need an API key from your live Customer Area.\nUse this API key to make requests to:\n\n```text\nhttps://postfmapi-live.adyen.com/postfmapi/terminal/v1\n```\n\n",
"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 [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).\n\n>We will deprecate POS Terminal Management API on January 1, 2025 and stop support on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).\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## Roles and permissions\nTo use the POS Terminal Management API, you need the **POS Terminal Management API role** added to your API credential. Your Adyen contact will set up the roles for you.\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`.\n## Going live\nTo access the live endpoints, you need an API key from your live Customer Area.\nUse this API key to make requests to:\n\n```text\nhttps://postfmapi-live.adyen.com/postfmapi/terminal/v1\n```\n\n",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
Expand Down
5 changes: 3 additions & 2 deletions yaml/TfmAPIService-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ info:
For more information, refer to [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).
>POS Terminal Management API will soon be deprecated. To automate the management
of your terminal fleet, we recommend you use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
>We will deprecate POS Terminal Management API on January 1, 2025 and stop support
on April 1, 2025. To automate the management of your terminal fleet, use our [Management
API](https://docs.adyen.com/api-explorer/Management/latest/overview).
## Authentication
Expand Down

0 comments on commit 8f753c0

Please sign in to comment.