Loggi Auth API

openapi: 3.2.0
info:
  title: Authentication Auth API
  version: v1
  description: Autenticação OAuth2 para acesso às APIs da Loggi.
servers:
- url: https://stg.api.loggi.com
- url: https://api.loggi.com
tags:
- name: AuthAPI
paths:
  /oauth2/token:
    post:
      summary: Autenticação V1
      description: 'Solicitação e atualização de token. O campo **idToken** deve ser informado no **Header** _Authorization_ de cada requisição às APIs da Loggi.


        ### ATENÇÃO!


        ⚠️ Esta api de autenticação está depreciada, por favor utilize a versão 2 da api de autenticação.'
      operationId: AuthenticateV1
      responses:
        '200':
          description: Criação ou atualização de token com sucesso
          content:
            application/json:
              schema:
                type: object
                description: Objeto que representa os dados de autenticação OAuth2
                properties:
                  idToken:
                    type: string
                    description: Token de autenticação. Deve ser informado no campo Auhtorization de cada endpoint.
                    example: eyJraWQiOiJIWTlqQk43Y2pJajYzN2RobUZ6
                  expiresIn:
                    type: string
                    description: Tempo de expiração do token em segundos.
                    example: '300'
        '400':
          description: Mensagem do cliente não segue a especificação
          content:
            application/json:
              example:
                code: 3
                message: Mensagem do cliente não segue a especificação
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Falha de autenticação
          content:
            application/json:
              example:
                code: 16
                message: Falha de autenticação
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: Sem autorização para acessar o serviço
          content:
            application/json:
              example:
                code: 7
                message: Falha de autorização
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: Requisições massivas bloqueadas
          content:
            application/json:
              example:
                code: 8
                message: Requisições massivas bloqueadas
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Erro interno
          content:
            application/json:
              example:
                code: 13
                message: Erro interno
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '503':
          description: Serviço temporariamente indisponível
          content:
            application/json:
              example:
                code: 14
                message: Serviço temporariamente indisponível
                details: []
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - client_id
              - client_secret
              properties:
                client_id:
                  type: string
                  description: Id do cliente cadastrado na Loggi.
                  example: loggi_cliente_xpto
                client_secret:
                  type: string
                  description: Chave secreta gerada pela Loggi.
                  example: PaSsWoRd!St@ong&R
              description: Objeto que representa os parâmetros para obtenção de um Token de acesso.
      tags:
      - AuthAPI
  /v2/oauth2/token:
    post:
      tags:
      - AuthAPI
      summary: Autenticação V2
      description: Solicitação de token para as APIs da Loggi.
      operationId: AuthenticateV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceAccountTokenRequest'
        required: true
      responses:
        '200':
          description: Return the JWT Token for the service account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceAccountTokenResponse'
        '400':
          description: Validation Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: 'Código numérico referente à falha.


            CANCELLED = 1


            UNKNOWN = 2


            INVALID_ARGUMENT = 3


            DEADLINE_EXCEEDED = 4


            NOT_FOUND = 5


            ALREADY_EXISTS = 6


            PERMISSION_DENIED = 7


            RESOURCE_EXHAUSTED = 8


            FAILED_PRECONDITION = 9


            ABORTED = 10


            OUT_OF_RANGE = 11


            UNIMPLEMENTED = 12


            INTERNAL = 13


            UNAVAILABLE = 14


            DATA_LOSS = 15


            UNAUTHENTICATED = 16'
          example: 14
        message:
          type: string
          description: Texto pequeno informativo sobre a falha.
          example: Requisição com credenciais inválidas.
        details:
          type: array
          description: Detalhes sobre a falha. Nesta versão da API, ainda não está sendo retornado, mas deve ser considerado um array de objetos de tipos distintos.
          items: {}
          example: []
    ServiceAccountTokenRequest:
      properties:
        client_id:
          type: string
          minLength: 1
          title: Client Id
        client_secret:
          type: string
          minLength: 1
          title: Client Secret
      type: object
      required:
      - client_id
      - client_secret
      title: ServiceAccountTokenRequest
    Problem:
      properties:
        type:
          type: string
          description: Uma referência de URI que identifica o tipo de problema.
        title:
          type: string
          description: Um resumo curto e legível para humanos do tipo de problema.
        status:
          type: integer
          description: O código de status HTTP gerado.
        detail:
          type: string
          description: Uma explicação legível para humanos específica para esta ocorrência do problema.
        instance:
          type: string
          description: Uma referência de URI que identifica a ocorrência específica do problema.
      type: object
    ServiceAccountTokenResponse:
      properties:
        idToken:
          type: string
          title: Idtoken
        expiresIn:
          type: string
          title: Expiresin
      type: object
      required:
      - idToken
      - expiresIn
      title: ServiceAccountTokenResponse
x-provenance:
  method: searched
  source: https://docs.api.loggi.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.api.loggi.com/reference/authapi.md
  - https://docs.api.loggi.com/reference/authenticatev1.md
  - https://docs.api.loggi.com/reference/authenticatev2.md
  merge:
    pages: 3
    deduped: 2
    conflicts_kept_first: 0