VTEX · Schema

3.GetCredentials

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
applicationId string This value is always identified as `vtex`.
appKey string It will be used in all API requests as X-VTEX-API-AppKey.
appToken string It will be used in all API requests as X-VTEX-API-AppToken.
View JSON Schema on GitHub

JSON Schema

vtex-3getcredentials-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/3.GetCredentials",
  "title": "3.GetCredentials",
  "required": [
    "applicationId",
    "appKey",
    "appToken"
  ],
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "This value is always identified as `vtex`."
    },
    "appKey": {
      "type": "string",
      "description": "It will be used in all API requests as X-VTEX-API-AppKey."
    },
    "appToken": {
      "type": "string",
      "description": "It will be used in all API requests as X-VTEX-API-AppToken."
    }
  },
  "example": {
    "applicationId": "vtex",
    "appKey": "c5a5e3f1-4a77-4a00-8b53-0d1adb3e9628",
    "appToken": "57ea254d-f3d3-488d-88d7-129766037ed1"
  }
}