> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar chave de API

> O segredo completo vem só nesta resposta, em `value`. Guarde na hora: não
há como consultá-lo depois. Se perder, revogue a chave e crie outra.




## OpenAPI

````yaml /api-reference/openapi.pt-BR.json post /account/api-keys
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    A API REST do Infi: catálogo, clientes, medição de uso, assinaturas,
    faturas,

    pagamentos e checkout.


    **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…`

    (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente.
    As

    rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no
    navegador

    de quem paga.


    **Idempotência.** Toda requisição que altera dados exige o header

    `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta
    original

    em vez de executar de novo.


    **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`,

    `"0.0001"`), nunca como número de ponto flutuante.


    **Erros.** O corpo traz `error_code` (estável, use para decidir), `message`

    (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de
    requisições

    e de idempotência vêm aninhados em `error`, com `code` e `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Catálogo
  - name: Clientes
  - name: Medição de uso
  - name: Assinaturas
  - name: Faturas
  - name: Pagamentos
  - name: Checkout
  - name: Cupons
  - name: Cobrança
  - name: Conta
  - name: Webhooks
  - name: Conta de teste
  - name: Rail
  - name: Lojas
paths:
  /account/api-keys:
    post:
      tags:
        - Conta
      summary: Criar chave de API
      description: >
        O segredo completo vem só nesta resposta, em `value`. Guarde na hora:
        não

        há como consultá-lo depois. Se perder, revogue a chave e crie outra.
      operationId: createApiKey
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tier:
                  type: string
                  enum:
                    - free
                    - pro
                    - enterprise
                  description: Plano de limite de requisições da chave.
                scopes:
                  type: array
                  items:
                    type: string
                  description: Permissões da chave. Vazio dá acesso completo à conta.
                kind:
                  type: string
                  enum:
                    - secret
                    - publishable
                  default: secret
                  description: >-
                    `secret` (padrão) para o servidor; `publishable` para o
                    navegador.
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedApiKey'
          description: Criado.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationFailed'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
      description: >-
        Chave única por operação (um UUID serve). Repetir com a mesma chave
        devolve a resposta original.
  schemas:
    CreatedApiKey:
      allOf:
        - $ref: '#/components/schemas/ApiKey'
        - type: object
          properties:
            secret:
              type: string
      description: A chave recém-criada, com o segredo completo em `value`.
    ApiKey:
      type: object
      properties:
        id:
          type: string
          format: uuid
        prefix:
          type: string
          example: sk_live
          description: '`sk_test`, `sk_live`, `pk_test` ou `pk_live`.'
        kind:
          type: string
          enum:
            - secret
            - publishable
          default: secret
        lastFour:
          type: string
          description: Os quatro últimos caracteres
        tier:
          type: string
          enum:
            - free
            - pro
            - enterprise
          description: Plano de limite de requisições.
        scopes:
          type: array
          items:
            type: string
        revokedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Quando foi revogada. `null` se está ativa.
        createdAt:
          type: string
          format: date-time
        value:
          type: string
          description: O segredo completo. Só aparece na resposta de criação.
    Error:
      type: object
      required:
        - message
        - error_code
        - tracer_id
      properties:
        message:
          type: string
          description: Frase legível para pessoas.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
          description: Código estável do erro. Use-o para decidir o que fazer.
        tracer_id:
          type: string
          description: Identificador da requisição. Informe-o ao falar com o suporte.
      description: >-
        O corpo de erro padrão. É plano (sem o envelope `error`) e o
        identificador de rastreio é `tracer_id`.
    ValidationError:
      type: object
      required:
        - message
        - error_code
        - tracer_id
        - errors
      properties:
        message:
          type: string
        error_code:
          $ref: '#/components/schemas/ErrorCode'
        tracer_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - value
              - constraint
              - description
            properties:
              field:
                type: string
              value:
                type: string
              constraint:
                type: string
              description:
                type: string
          description: >-
            Detalhe por campo (`field`, `description`). Sempre presente num
            `422`; pode vir vazio.
      description: >-
        Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o
        detalhe por campo. É ali que está a frase que diz o que corrigir (por
        exemplo, "product has no published version").
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Código estável do erro. A lista não é fechada: além dos códigos
        genéricos, cada área tem os seus (`coupon_expired`,
        `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…).
        Um código que você não conhece deve ser tratado pelo status HTTP,
        mostrando `message`; não falhe ao ler a resposta.
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Chave ausente ou inválida.
    ValidationFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
      description: >-
        Um ou mais campos são inválidos. O detalhe de cada campo está em
        `errors[]`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````