VTex License Manager API — App Keys

naftiko: 1.0.0-alpha2
info:
  label: VTex License Manager API — App Keys
  description: 'VTex License Manager API — App Keys. 3 operations. Lead operation: VTex Create new appKey. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - App Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: license-manager-app-keys
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex License Manager API — App Keys business capability. Self-contained, no shared references.
    resources:
    - name: api-vlm-appkeys
      path: /api/vlm/appkeys
      operations:
      - name: createnewappkey
        method: POST
        description: VTex Create new appKey
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getappkeysfromaccount
        method: GET
        description: VTex Get appKeys from account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-vlm-appkeys-id
      path: /api/vlm/appkeys/{id}
      operations:
      - name: updateappkey
        method: PUT
        description: VTex Update appKey
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID from the appKey which will be updated
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: license-manager-app-keys-rest
    port: 8080
    description: REST adapter for VTex License Manager API — App Keys. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/vlm/appkeys
      name: api-vlm-appkeys
      description: REST surface for api-vlm-appkeys.
      operations:
      - method: POST
        name: createnewappkey
        description: VTex Create new appKey
        call: license-manager-app-keys.createnewappkey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getappkeysfromaccount
        description: VTex Get appKeys from account
        call: license-manager-app-keys.getappkeysfromaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/vlm/appkeys/{id}
      name: api-vlm-appkeys-id
      description: REST surface for api-vlm-appkeys-id.
      operations:
      - method: PUT
        name: updateappkey
        description: VTex Update appKey
        call: license-manager-app-keys.updateappkey
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: license-manager-app-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex License Manager API — App Keys. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-create-new-appkey
      description: VTex Create new appKey
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: license-manager-app-keys.createnewappkey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-appkeys-account
      description: VTex Get appKeys from account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: license-manager-app-keys.getappkeysfromaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-appkey
      description: VTex Update appKey
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: license-manager-app-keys.updateappkey
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.