How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Authentication API

The Authentication API from VTEX — 7 operation(s) for authentication.

VTEX Authentication API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://{accountName}.{environment}.com.br, https://auth.pickingnpacking.com/{environment}, https://{store_endpoint}, https://api.pickingnpacking.com/{environment}/v1/tracking/hook, https://api.vtextracking.com/receiver.

7 operations 7 paths 3 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

VTEX Authentication API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-VTEX-API-AppKey (appKey). An API key is passed in the header as X-VTEX-API-AppToken (appToken). An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie). It accepts HTTP bearer tokens (Authorization).

  • appKey — Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
  • appToken — Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.
  • Authorization — To use the endpoints, please login through the Authentication API, and copy the access token in the response.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 7
POST
/api/vtexid/apptoken/login
VTex Generate authentication token
postApiVtexidApptokenLogin 3 params body → 200
POST
/api/vtexid/audience/webstore/provider/oauth/exchange
Exchange OAuth access token for VTEX credential
postApiVtexidAudienceWebstoreProviderOauthExchange 4 params body → 200
POST
/api/vtexid/credential/validate
VTex Check authenticated user
postApiVtexidCredentialValidate 4 params body → 200401
POST
/api/vtexid/pub/providers/setup/password/webstore/password
VTex Enable or disable repeated passwords
postApiVtexidPubProvidersSetupPasswordWebstorePassword 3 params body → 200
POST
/api/vtexid/password/expire
VTex Expire user password
postApiVtexidPasswordExpire 5 params → 200
POST
/token
VTex Create JWT token
Createtoken 2 params body → 200
POST
/auth
VTex Asynchronous Login
postAuth 2 params body → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TokenResponse (5 properties), credentials (2 properties), CreatetokenRequest (1 property). Each schema is shown below with its type and property counts.

credentials
object
Credentials object, composed of application key and application token.
2 properties 2 required
CreatetokenRequest
object
1 property 1 required
TokenResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-authentication-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
VTEX Category Specification API
Where this information came from

This is an independent, third-party profile of VTEX Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.