From b05a951db341e7ab77f34bd452d68219f499f48d Mon Sep 17 00:00:00 2001 From: Aleksei Akimov Date: Mon, 25 Jun 2018 16:45:03 +0200 Subject: [PATCH] Create CheckoutUtilityService-v1.json --- specs/3.0/CheckoutUtilityService-v1.json | 97 ++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 specs/3.0/CheckoutUtilityService-v1.json diff --git a/specs/3.0/CheckoutUtilityService-v1.json b/specs/3.0/CheckoutUtilityService-v1.json new file mode 100644 index 0000000..fea36cb --- /dev/null +++ b/specs/3.0/CheckoutUtilityService-v1.json @@ -0,0 +1,97 @@ +{ + "openapi" : "3.0.0", + "servers" : [ + { + "url" : "https://checkout-test.adyen.com/v1" + } + ], + "info" : { + "version" : "1", + "title" : "Adyen Checkout Utility Service", + "description" : "A web service containing utility functions available for merchants integrating with Checkout APIs.\n## Authentication\nEach request to the Checkout Utility 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 Checkout API key](https://docs.adyen.com/developers/user-management/how-to-get-the-checkout-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_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/api-reference/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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://checkout-test.adyen.com/v1/originKeys\n```", + "termsOfService" : "https://docs.adyen.com/legal/terms-conditions", + "contact" : { + "name" : "Adyen Support", + "url" : "https://support.adyen.com/", + "email" : "support@adyen.com" + } + }, + "x-groups" : [ + "General" + ], + "paths" : { + "/originKeys" : { + "post" : { + "summary" : "Create originKey values for one or more merchant domains.", + "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains.", + "x-groupName" : "General", + "x-sortIndex" : 0, + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CheckoutUtilityRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CheckoutUtilityResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "description" : "Bad Request - a problem reading or understanding the request." + }, + "422" : { + "description" : "Unprocessable Entity - a request validation error." + }, + "401" : { + "description" : "Unauthorized - authentication required." + }, + "500" : { + "description" : "Internal Server Error - the server could not process the request." + }, + "403" : { + "description" : "Forbidden - insufficient permissions to process the request." + } + } + } + } + }, + "components" : { + "schemas" : { + "CheckoutUtilityRequest" : { + "properties" : { + "originDomains" : { + "description" : "The list of origin domains, for which origin keys are requested.", + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ + "originDomains" + ] + }, + "CheckoutUtilityResponse" : { + "properties" : { + "originKeys" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", + "type" : "object" + } + } + } + } + } +}