Central Fox Tecnologia LTDA Auth API

openapi: 3.2.0
info:
  title: FOX NF-e Auth API
  version: '1.20260923'
  description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Auth
paths:
  /api/v1/auth/login:
    post:
      operationId: post_api_v1_auth_login
      tags:
      - Auth
      summary: Auth login
      x-source: app/app/Http/Controllers/Auth/AuthController.php:19
      x-middleware:
      - api
      - throttle:5,1
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Auth/AuthController.php:50
                  token_type:
                    type: string
                    example: Bearer
                  abilities:
                    type: array
                    items:
                      type: string
                      example: certificates:read
                  expires_at:
                    type: string
                    format: date-time
                  user:
                    type: object
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:55
                      name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:56
                      email:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:57
                      tenant_id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:58
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    token: null
                    token_type: Bearer
                    abilities:
                    - certificates:read
                    expires_at: '2026-10-01T12:00:00Z'
          x-source:
          - app/app/Http/Controllers/Auth/AuthController.php:49
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_auth_loginRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  email: integracao@example.invalid
                  password: EXEMPLO_FICTICIO
  /api/v1/auth/register:
    post:
      operationId: post_api_v1_auth_register
      tags:
      - Auth
      summary: Register register
      x-source: app/app/Http/Controllers/Auth/RegisterController.php:39
      x-middleware:
      - api
      - throttle:5,1
      responses:
        '201':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Auth/RegisterController.php:110
                  abilities:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Auth/RegisterController.php:111
                  tenant:
                    type: object
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:113
                      slug:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:114
                      plan:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:115
                      trial_ends_at:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:116
                      nfe_ambiente:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:117
                  user:
                    type: object
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:120
                      email:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/RegisterController.php:121
                  proximo_passo:
                    type: string
                    example: 'Acesse /onboarding para completar: dados fiscais → certificado A1 → teste de NF-e em homologação.'
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    token: null
                    abilities: null
                    tenant:
                      id: null
                      slug: null
                      plan: null
                      trial_ends_at: null
                    user:
                      id: null
                      email: null
          x-source:
          - app/app/Http/Controllers/Auth/RegisterController.php:109
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_auth_registerRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  name: EXEMPLO_FICTICIO
                  email: integracao@example.invalid
                  password: EXEMPLO_FICTICIO
  /api/v1/auth/forgot-password:
    post:
      operationId: post_api_v1_auth_forgot_password
      tags:
      - Auth
      summary: PasswordReset forgot
      x-source: app/app/Http/Controllers/Auth/PasswordResetController.php:29
      x-middleware:
      - api
      - throttle:5,1
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Se o e-mail estiver cadastrado, enviaremos um link de redefinição de senha.
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    ok: true
                    message: Se o e-mail estiver cadastrado, enviaremos um link de redefinição de senha.
          x-source:
          - app/app/Http/Controllers/Auth/PasswordResetController.php:35
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_auth_forgot_passwordRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  email: integracao@example.invalid
  /api/v1/auth/reset-password:
    post:
      operationId: post_api_v1_auth_reset_password
      tags:
      - Auth
      summary: PasswordReset reset
      x-source: app/app/Http/Controllers/Auth/PasswordResetController.php:45
      x-middleware:
      - api
      - throttle:5,1
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Senha redefinida com sucesso. Faça login com a nova senha.
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    ok: true
                    message: Senha redefinida com sucesso. Faça login com a nova senha.
          x-source:
          - app/app/Http/Controllers/Auth/PasswordResetController.php:65
        '422':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: reset_failed
                  message:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Auth/PasswordResetController.php:74
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    ok: false
                    error: reset_failed
                    message: null
          x-source:
          - app/app/Http/Controllers/Auth/PasswordResetController.php:71
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_auth_reset_passwordRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  token: EXEMPLO_FICTICIO
                  email: integracao@example.invalid
                  password: null
  /api/v1/auth/logout:
    post:
      operationId: post_api_v1_auth_logout
      tags:
      - Auth
      summary: Auth logout
      x-source: app/app/Http/Controllers/Auth/AuthController.php:63
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    ok: true
          x-source:
          - app/app/Http/Controllers/Auth/AuthController.php:77
      security:
      - bearerAuth: []
  /api/v1/auth/me:
    get:
      operationId: get_api_v1_auth_me
      tags:
      - Auth
      summary: Auth me
      x-source: app/app/Http/Controllers/Auth/AuthController.php:80
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      responses:
        '401':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: unauthenticated
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    error: unauthenticated
          x-source:
          - app/app/Http/Controllers/Auth/AuthController.php:84
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:107
                      name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:108
                      email:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:109
                      tenant_id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:110
                  tenant:
                    type:
                    - object
                    - 'null'
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:113
                      slug:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:114
                      name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:115
                      status:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:116
                  subscription:
                    type:
                    - object
                    - 'null'
                    properties:
                      plan_code:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:119
                      plan_name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:120
                      status:
                        type: string
                        enum:
                        - draft
                        - pending
                        - processing
                        - authorized
                        - rejected
                        - denied
                        - canceled
                        - contingency
                        x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
                      billing_cycle:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Auth/AuthController.php:122
                      trial_ends_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
                      current_period_end:
                        type:
                        - string
                        - 'null'
                        format: date-time
                  abilities:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Auth/AuthController.php:126
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    user:
                      id: null
                      name: null
                      email: null
                      tenant_id: null
                    tenant:
                      id: null
                      slug: null
                      name: null
                      status: null
                    subscription:
                      plan_code: null
                      plan_name: null
                      status: draft
                      billing_cycle: null
                    abilities: null
          x-source:
          - app/app/Http/Controllers/Auth/AuthController.php:105
      security:
      - bearerAuth: []
components:
  schemas:
    post_api_v1_auth_registerRequest:
      type: object
      properties:
        name:
          x-laravel-rules:
          - required
          - string
          - max:120
          type: string
          maxLength: 120
        email:
          x-laravel-rules:
          - required
          - email
          - max:255
          x-laravel-custom-validation: true
          description: Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização).
          type: string
          format: email
          maxLength: 255
        password:
          x-laravel-rules:
          - required
          - string
          - min:8
          - max:72
          type: string
          minLength: 8
          maxLength: 72
        empresa:
          x-laravel-rules:
          - sometimes
          - nullable
          - string
          - max:120
          type:
          - string
          - 'null'
          maxLength: 120
        referral_code:
          x-laravel-rules:
          - sometimes
          - nullable
          - string
          - max:40
          type:
          - string
          - 'null'
          maxLength: 40
      required:
      - name
      - email
      - password
      x-source:
      - app/app/Http/Controllers/Auth/RegisterController.php:41
    post_api_v1_auth_loginRequest:
      type: object
      properties:
        email:
          x-laravel-rules:
          - required
          - string
          - email
          - max:255
          type: string
          format: email
          maxLength: 255
        password:
          x-laravel-rules:
          - required
          - string
          - min:8
          - max:255
          type: string
          minLength: 8
          maxLength: 255
        device_name:
          x-laravel-rules:
          - sometimes
          - string
          - max:100
          type: string
          maxLength: 100
      required:
      - email
      - password
      x-source:
      - app/app/Http/Controllers/Auth/AuthController.php:21
    post_api_v1_auth_forgot_passwordRequest:
      type: object
      properties:
        email:
          x-laravel-rules:
          - required
          - email
          - max:255
          type: string
          format: email
          maxLength: 255
      required:
      - email
      x-source:
      - app/app/Http/Controllers/Auth/PasswordResetController.php:31
    post_api_v1_auth_reset_passwordRequest:
      type: object
      properties:
        token:
          x-laravel-rules:
          - required
          - string
          type: string
        email:
          x-laravel-rules:
          - required
          - email
          type: string
          format: email
        password:
          x-laravel-rules:
          - required
          - confirmed
          x-laravel-custom-validation: true
          description: Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Exige confirmação no campo de mesmo nome com sufixo _confirmation .
      required:
      - token
      - email
      - password
      x-source:
      - app/app/Http/Controllers/Auth/PasswordResetController.php:47
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer