VTEX · Schema

credentials

Credentials object, composed of application key and application token.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
appkey string Application key.
apptoken string Application token corresponding to the application key sent with it.
View JSON Schema on GitHub

JSON Schema

vtex-credentials-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/credentials",
  "title": "credentials",
  "type": "object",
  "description": "Credentials object, composed of application key and application token.",
  "required": [
    "appkey",
    "apptoken"
  ],
  "properties": {
    "appkey": {
      "type": "string",
      "description": "Application key.",
      "example": "vtexappkey-example-YSWQFZ"
    },
    "apptoken": {
      "type": "string",
      "description": "Application token corresponding to the application key sent with it.",
      "example": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjA1MTZFN0IwMDNFODMxRTg0QkFDOTg2NzBCNUM2QTRERTlBN0RFNkUiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwZWRyby5jb3N0YUB2dGV4LmNvbS5iciIsImFjY291bnQiOiJhcHBsaWFuY2V0aGVtZSIsImF1ZGllbmNlIjoiYWRtaW4iLCJzZXNzIjoiZjU3YjMyMGItMWE3YS00YzlkLWJkNDMtZTE4NDdhYmE1MTE1IiwiZXhwIjoxNjE2NzY3Mjc4LCJ1c2VySWQiOiJmYjU0MmU1MS01NDg4LTRjMzQtOGQxNy1lZDhmY2Y1OTdhOTQiLCJpYXQiOjE2MwerY2ODA4NzgsImlzcyI6InRva2VuLWVtaXR0ZXIiLCJqdGkiOiJmYTI0YWJiOC03Y2E5LTQ3NjUtYmYzNC1kMmvU5YTgzYjYxZmUifQ.23rn-2dEdAAYXJX2exrxDEdbieyKWsVKABeSUNeFWyhz7xRd7d5EcxwiMLjM3bRaBOKrAA9Op7ocn89c45qQ"
    }
  }
}