diff --git a/PostmanCollections/VTEX - Antifraud Provider API.json b/PostmanCollections/VTEX - Antifraud Provider API.json index d3dcfbe23..71fb04d4d 100644 --- a/PostmanCollections/VTEX - Antifraud Provider API.json +++ b/PostmanCollections/VTEX - Antifraud Provider API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "78ffe0da-da8d-44ba-ae20-ed7a8a1472e3" + "postman_id": "8d657a1f-c174-4213-9d9b-a3ca57682045" }, "item": [ { - "id": "c4702ac1-e626-447c-9dff-d1321221c58c", + "id": "7f867837-c561-4df1-9744-19da57599df2", "name": "Anti-fraud Flow", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "6df4582c-4bc0-49c3-b139-94d78b768758", + "id": "6c7eb1d9-8234-4e9c-a34d-d329b37e7694", "name": "Send anti-fraud pre-analysis data (optional)", "request": { "name": "Send anti-fraud pre-analysis data (optional)", @@ -113,7 +113,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "edd9399f-d417-4370-b9de-2402ae44f580", + "id": "a48ab1e7-017b-4799-8025-4436d8be8ee1", "name": "OK", "originalRequest": { "url": { @@ -208,7 +208,7 @@ { "listen": "test", "script": { - "id": "347f5f8c-3fd1-415c-a890-e412989b71b7", + "id": "4557d9c5-c62a-4161-b734-ded33f992023", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pre-analysis - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -224,7 +224,7 @@ } }, { - "id": "18b42d31-b025-4bb0-9f2f-dcff7b6f12c4", + "id": "a192fea7-c09f-4971-91fb-5846ce6652c0", "name": "Send anti-fraud data", "request": { "name": "Send anti-fraud data", @@ -325,7 +325,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "772fe3b5-afd2-4824-a37e-16aeacbaadcf", + "id": "5c508581-b7c5-4db6-a9ca-fefa2e33e78f", "name": "OK", "originalRequest": { "url": { @@ -420,7 +420,7 @@ { "listen": "test", "script": { - "id": "57c6c214-48f3-424f-82b3-5b1e56541402", + "id": "46b0abad-6946-48f4-9e08-11546d88095c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -436,7 +436,7 @@ } }, { - "id": "7c404f1e-cb5c-4232-b5a9-0d2d34ed2789", + "id": "e34a1838-c2cc-4bd9-9c27-a60dda75532b", "name": "Update anti-fraud transactions (optional)", "request": { "name": "Update anti-fraud transactions (optional)", @@ -553,7 +553,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7482fcfa-e3ef-4e27-aae7-43e0a3bd2a50", + "id": "8c898370-76b2-44c4-b02f-687fb83349cc", "name": "OK", "originalRequest": { "url": { @@ -649,7 +649,7 @@ { "listen": "test", "script": { - "id": "f3cb5e2b-01d5-4f0c-bd39-818091ad54a1", + "id": "6e4184af-e75d-45b5-a2df-e89a5a6c892d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -665,7 +665,7 @@ } }, { - "id": "d4ad6394-9bc9-45c1-a89a-e42d23f9def5", + "id": "5e61c955-875a-48ce-8cfd-ecf07f8ccb87", "name": "List anti-fraud provider manifest", "request": { "name": "List anti-fraud provider manifest", @@ -715,7 +715,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "73e050d2-0718-471a-8f01-3971a5d71970", + "id": "56ee9e61-74e7-49ab-91e1-f76d02116112", "name": "OK", "originalRequest": { "url": { @@ -763,7 +763,7 @@ "value": "application/json" } ], - "body": "{\n \"cardholderDocument\": \"required\",\n \"customFields\": [\n {\n \"name\": \"ApiKey\",\n \"type\": \"text\"\n },\n {\n \"name\": \"AnalysisLocation\",\n \"type\": \"select\",\n \"options\": [\n {\n \"text\": \"MEX\",\n \"value\": \"Latin America\"\n },\n {\n \"text\": \"USA\",\n \"value\": \"United States\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"cardholderDocument\": \"required\",\n \"customFields\": [\n {\n \"name\": \"AnalysisMode\",\n \"type\": \"text\"\n },\n {\n \"name\": \"Client secret\",\n \"type\": \"password\"\n },\n {\n \"name\": \"AnalysisLocation\",\n \"type\": \"select\",\n \"options\": [\n {\n \"text\": \"MEX\",\n \"value\": \"Latin America\"\n },\n {\n \"text\": \"USA\",\n \"value\": \"United States\"\n }\n ]\n }\n ]\n}", "cookie": [] } ], @@ -771,13 +771,13 @@ { "listen": "test", "script": { - "id": "a4445531-4831-4453-84eb-2e0d2c975086", + "id": "f7da537b-59e1-4dd0-91f2-95ebd89012c8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/manifest - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/manifest - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/manifest - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"customFields\":{\"type\":\"array\",\"description\":\"Custom fields information.\",\"items\":{\"type\":\"object\",\"description\":\"Item information.\",\"additionalProperties\":true,\"properties\":{}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"customFields\":{\"type\":\"array\",\"description\":\"Describes the customized fields supported by the connector.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"type\":{\"type\":\"string\",\"description\":\"Custom field type. Sensitive or security data should be defined as `password`\",\"enum\":[\"text\",\"password\",\"select\"]},\"options\":{\"type\":\"array\",\"description\":\"In case of `select` type, the possible params are `text` and `value`.\",\"items\":{\"type\":\"object\",\"description\":\"Custom field information.\",\"properties\":{\"text\":{\"type\":\"string\",\"description\":\"Custom field description.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -787,7 +787,7 @@ } }, { - "id": "316ddd05-3329-4755-be9e-e30e36fe2944", + "id": "572fb6a0-4b04-45ba-8538-7a0f02864746", "name": "Get anti-fraud status", "request": { "name": "Get anti-fraud status", @@ -891,7 +891,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4d88c125-6c74-44cc-82be-e0cd277ce0bf", + "id": "5b047ceb-785a-4d91-96ff-620de48861d2", "name": "OK", "originalRequest": { "url": { @@ -974,7 +974,7 @@ { "listen": "test", "script": { - "id": "5f99f699-532b-40ac-bfa4-6a0f37affc50", + "id": "d1d8359c-29a8-4c51-a3a9-770e5eec6b89", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/transactions/:transactions.id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -990,7 +990,7 @@ } }, { - "id": "6dfc7e93-6c72-4491-8941-72135b37c862", + "id": "f0f6745c-2742-45b8-a1ba-615987c6ca4e", "name": "Stop anti-fraud analysis (optional)", "request": { "name": "Stop anti-fraud analysis (optional)", @@ -1094,7 +1094,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0d0fcc4e-42d4-4654-a327-41283d08dfc7", + "id": "135f7b14-a49b-4088-b5c0-2750e9a03eb8", "name": "OK", "originalRequest": { "url": { @@ -1177,7 +1177,7 @@ { "listen": "test", "script": { - "id": "e49a4f83-49d2-4da5-a898-aa1747d0bb72", + "id": "f4df1946-6ec6-40fe-af9d-9d6e10216384", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/transactions/:transactions.Id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1196,7 +1196,7 @@ "event": [] }, { - "id": "2dc338aa-360c-4347-93e7-758cc717e2e0", + "id": "99977d4c-bc42-4082-a1da-e9627e325266", "name": "OAuth Flow", "description": { "content": "", @@ -1204,7 +1204,7 @@ }, "item": [ { - "id": "c7188b4b-4f43-4bb9-a36e-a99638113f0f", + "id": "bb272269-9582-4ed8-ba32-3e4f076e6786", "name": "1. Retrieve token", "request": { "name": "1. Retrieve token", @@ -1306,7 +1306,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d47e9da9-e1d3-44ad-af61-961f6fc09679", + "id": "83c5db5a-fc36-48c8-bfbd-65e84fdc2c69", "name": "OK", "originalRequest": { "url": { @@ -1402,7 +1402,7 @@ { "listen": "test", "script": { - "id": "5f1ac783-b5d8-43c3-9b60-256fed6ed25d", + "id": "3bc0969a-0d9a-4079-9c49-3178d193093d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/authorization/token - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1418,7 +1418,7 @@ } }, { - "id": "464005bf-101b-4326-8bd1-3f3b6cd8b374", + "id": "97aed2a5-e705-4acb-8b3f-407dda4580e3", "name": "2. Redirect", "request": { "name": "2. Redirect", @@ -1521,7 +1521,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "938d44fe-1cee-4cf4-9ce7-125b95379789", + "id": "d9ffcc9b-9080-4589-954a-7ebea2d93371", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -1612,7 +1612,7 @@ { "listen": "test", "script": { - "id": "38498704-1d10-4847-b2dd-a39c8ad23875", + "id": "bee2c9df-7eb4-48ec-8408-ac329e01d920", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/redirect - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1625,7 +1625,7 @@ } }, { - "id": "7a466759-ab17-48f3-801b-6142aa63197e", + "id": "7fe26d2a-ae9b-424d-9a69-14a234c4d6d8", "name": "3. Return to VTEX", "request": { "name": "3. Return to VTEX", @@ -1701,7 +1701,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "143439da-614a-43d4-9605-7fa1565f9c42", + "id": "76d89ca4-d4ee-4db9-bc3a-0f1a1f8ac871", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -1765,7 +1765,7 @@ { "listen": "test", "script": { - "id": "df9c03b5-6a7d-48cf-b151-c5078bf43556", + "id": "b50ee99a-460a-43c4-a08e-3e172ea425d3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/authorizationCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1778,7 +1778,7 @@ } }, { - "id": "687ebcfa-7e9f-460a-9f2d-616384e55417", + "id": "c1a13842-59f3-48d8-b315-dceb582415ba", "name": "4. Get credentials", "request": { "name": "4. Get credentials", @@ -1868,7 +1868,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6c5716a1-4628-4fa2-abcd-b2ae9f0f01bb", + "id": "94642488-05f6-4789-8377-ae41e5bb8cd3", "name": "OK", "originalRequest": { "url": { @@ -1952,7 +1952,7 @@ { "listen": "test", "script": { - "id": "876bebd4-9b4a-4d00-a7ce-0b498e516f39", + "id": "bd3a2550-19a8-4562-bce0-054d9f7e7a48", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/authorization/credentials - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1985,7 +1985,7 @@ } ], "info": { - "_postman_id": "78ffe0da-da8d-44ba-ae20-ed7a8a1472e3", + "_postman_id": "8d657a1f-c174-4213-9d9b-a3ca57682045", "name": "Anti-fraud Provider API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Antifraud Provider API.json b/VTEX - Antifraud Provider API.json index 51bc4f6aa..dbebe2337 100644 --- a/VTEX - Antifraud Provider API.json +++ b/VTEX - Antifraud Provider API.json @@ -343,9 +343,13 @@ "cardholderDocument": "required", "customFields": [ { - "name": "ApiKey", + "name": "AnalysisMode", "type": "text" }, + { + "name": "Client secret", + "type": "password" + }, { "name": "AnalysisLocation", "type": "select", @@ -787,11 +791,39 @@ }, "customFields": { "type": "array", - "description": "Custom fields information.", + "description": "Describes the customized fields supported by the connector.", "items": { "type": "object", - "description": "Item information.", - "additionalProperties": true + "description": "Custom fields information.", + "properties": { + "name": { + "type": "string", + "description": "Custom field name." + }, + "type": { + "type": "string", + "description": "Custom field type. Sensitive or security data should be defined as `password`.", + "enum": ["text", "password", "select"] + }, + "options": { + "type": "array", + "description": "In case of `select` type, the possible params are `text` and `value`.", + "items": { + "type": "object", + "description": "Custom field information.", + "properties": { + "text": { + "type": "string", + "description": "Custom field description." + }, + "value": { + "type": "string", + "description": "Custom field value." + } + } + } + } + } } } }