find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vtex-app-keys-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: VTex License Manager App Keys API
  description: The License Manager API allows you to create users, modify their names and emails, add and remove roles from users, and create and manage appKeys.
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: App Keys
paths:
  /api/vlm/appkeys:
    post:
      tags:
      - App Keys
      summary: VTex Create new appKey
      description: 'Creates a new pair of `appKey` and `appToken`.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | License Manager | Services access control | **Save user** |


        You can create a custom role with that resource or use one of the following predefined roles:


        | **Role** | **Resource** |

        | --------------- | ----------------- |

        | User Administrator - RESTRICTED | Save user |


        >❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.


        To learn more about machine authentication at VTEX, see Authentication overview.'
      operationId: Createnewappkey
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatenewappkeyRequest'
            example:
              label: my new appkey
        required: true
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatenewappkeyResponse'
              example:
                id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                appKey: vtexappkey-myaccount-ORYNWX
                appToken: WNVUJKYFKJFLTPXHQGAZDHPBHSDQVJJWSFZUBOGCKPEXAIFHTPANKJTOXUKRIIJAAJSOPCFBAXOODRABMUXFJVLJLKWGEOUCFDXRPRRQKYNNUFLGTIEOKERFXJCFFYXL
                label: my new appkey
                createdIn: '2018-07-04T14:09:08.2718405Z'
                isActive: true
      deprecated: false
    get:
      tags:
      - App Keys
      summary: VTex Get appKeys from account
      description: 'Retrieves all application keys from an account.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | License Manager | Services access control | **Save user** |


        You can create a custom role with that resource or use one of the following predefined roles:


        | **Role** | **Resource** |

        | --------------- | ----------------- |

        | User Administrator - RESTRICTED | Save user |


        >❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.


        To learn more about machine authentication at VTEX, see Authentication overview.'
      operationId: Getappkeysfromaccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      responses:
        '200':
          description: Success
          headers: {}
          content:
            application/json:
              schema:
                type: array
                description: Array of AppKeys object
                items:
                  $ref: '#/components/schemas/Getappkeysfromaccount'
              example:
              - id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                appKey: vtexappkey-myaccount-ORYNWX
                label: my new appkey
                createdIn: '2018-07-04T14:09:08.2718405Z'
                isActive: true
              - id: a2555e95-9db8-48be-94f8-2a28577c0b4a
                appKey: vtexappkey-myaccount-ORKPDC
                label: my other appkey
                createdIn: '2018-07-04T14:09:08.2718405Z'
                isActive: true
      deprecated: false
  /api/vlm/appkeys/{id}:
    put:
      tags:
      - App Keys
      summary: VTex Update appKey
      description: 'Activates or deactivates an `appKey` by its ID.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | License Manager | Services access control | **Save user** |


        You can create a custom role with that resource or use one of the following predefined roles:


        | **Role** | **Resource** |

        | --------------- | ----------------- |

        | User Administrator - RESTRICTED | Save user |


        >❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.


        To learn more about machine authentication at VTEX, see Authentication overview.'
      operationId: Updateappkey
      parameters:
      - name: id
        in: path
        description: ID from the appKey which will be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request body for updating AppKeys
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateappkeyRequest'
            example:
              isActive: false
        required: true
      responses:
        '200':
          description: Success
          headers: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VLMError'
              example:
                Details: null
                HttpStatusCode: 400
                VLMErrorCode: 17
                Message: Token not exists for this account
      deprecated: false
components:
  parameters:
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
  schemas:
    VLMError:
      description: Object representing VLMError.
      type: object
      properties:
        Details:
          description: Details of error.
          type:
          - string
          - 'null'
        HttpStatusCode:
          description: Status code of HTTP response.
          type: integer
        VLMErrorCode:
          description: Error code for License Manager.
          type: integer
        Message:
          description: Error message.
          type: string
    UpdateappkeyRequest:
      description: Request body for activating or deactivating application keys.
      required:
      - isActive
      type: object
      properties:
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
          example: true
    Getappkeysfromaccount:
      description: Response body for getting all application keys from the account.
      required:
      - id
      - appKey
      - label
      - createdIn
      - isActive
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
    CreatenewappkeyResponse:
      description: Response body of sucessful call to /api/vlm/appkeys.
      required:
      - id
      - appKey
      - appToken
      - label
      - createdIn
      - isActive
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        appToken:
          description: AppToken. For security reasons, it should always be null.
          type:
          - string
          - 'null'
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
    CreatenewappkeyRequest:
      description: Request body for creating new application key (/api/vlm/appkeys)
      required:
      - label
      type: object
      properties:
        label:
          description: Label of the application key.
          type: string
          example: appkey-test
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'