{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Authentication API", "version": "1.0" }, "items": [ { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "VTex Generate authentication token", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/vtexid/apptoken/login", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate a [token](https://developers.vtex.com/vtex-rest-api/docs/getting-started-authentication#user-token) from a given [app key and app token](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet) pair. You can use this token to authenticate requests to VTEX APIs by sending it as a header named `VtexIdclientAutCookie`. The token's permissions are the same as [defined to the credential pair](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet#managi" }, { "info": { "name": "Exchange OAuth access token for VTEX credential", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/vtexid/audience/webstore/provider/oauth/exchange", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "accountName", "value": "", "type": "path", "description": "Name of your VTEX account." }, { "name": "environment", "value": "", "type": "path", "description": "Environment to be used in the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If your store uses a headless frontend, you can authenticate users via OAuth and use this endpoint to exchange the OAuth access token for a VTEX authentication token. This VTEX token can be used to authenticate your frontend requests to VTEX APIs.\n\r\n\rLearn more about how to implement [headless authentication](https://developers.vtex.com/docs/guides/headless-authentication) in your store.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-m" }, { "info": { "name": "VTex Check authenticated user", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/vtexid/credential/validate", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." }, { "name": "environment", "value": "", "type": "path", "description": "Environment to be used in the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves information about the user who is currently authenticated in your store, given an user token. If the user is not authenticated, the response for this API will be `401 (Unauthorized)`.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)." }, { "info": { "name": "VTex Enable or disable repeated passwords", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/vtexid/pub/providers/setup/password/webstore/password", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "accountName", "value": "", "type": "path", "description": "Name of your VTEX account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Defines if user passwords can be repeated in your store. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#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" }, { "info": { "name": "VTex Expire user password", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/vtexid/password/expire", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "accountName", "value": "", "type": "path", "description": "Name of your VTEX account." }, { "name": "environment", "value": "", "type": "path", "description": "Environment to be used in the request." }, { "name": "email", "value": "", "type": "query", "description": "User email." } ] }, "docs": "Expires an user's password in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#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**" }, { "info": { "name": "VTex Create JWT token", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/token", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a `JWT` (JSON Web Token) necessary to access the Pick and Pack Last Mile Protocol API information.\r\n\r\n>ℹ️ To generate the `JWT` it is necessary to have the `API KEY` previously generated by the Pick and Pack team.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)." }, { "info": { "name": "VTex Asynchronous Login", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/auth", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint permits the user to acquire the mandatory authentication to access the VTEX Tracking endpoints. \r\n> There is a single version of VTEX Tracking API, so it is no longer necessary to specify the version on the URL, as explained in this [release note](https://developers.vtex.com/updates/release-notes/vtex-tracking-api-changes-in-all-paths). The previous routes were not deprecated and can still be used, and if there is a breaking change, it will be informed." } ] } ], "bundled": true }