{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Policy API", "version": "1.0" }, "items": [ { "info": { "name": "Policy", "type": "folder" }, "items": [ { "info": { "name": "VTex Get policy list", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/policy-engine/policies", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": "Retrieves a list of all policies in the account and general information of each policy.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicabl" }, { "info": { "name": "VTex Evaluate policies", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/policy-engine/evaluate", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint consults all policies and checks the ones that satisfy the request body’s conditions.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are t" }, { "info": { "name": "VTex Get policy by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/policy-engine/policies/:id", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID." } ] }, "docs": "Retrieves general information of a policy by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n|" }, { "info": { "name": "VTex Create policy", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/policy-engine/policies/:id", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new policy from scratch.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **C" }, { "info": { "name": "VTex Update policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/policy-engine/policies/:id", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing policy at your account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Produc" }, { "info": { "name": "VTex Delete policy by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/policy-engine/policies/:id", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Policy ID." } ] }, "docs": "Deletes a specific policy of the account by its ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| " } ] } ], "bundled": true }