Loggi O Auth2 Token API

openapi: 3.2.0
info:
  title: Package O Auth2 Token API
  version: v1
  description: Disponibiliza serviços para atuar sobre um pacote.
servers:
- url: https://stg.api.loggi.com
- url: https://api.loggi.com
tags:
- name: OAuth2Token
paths:
  /oauth2/token:
    post:
      summary: Criar/Atualizar Token
      description: Solicitação e atualização de token. O campo **idToken** deve ser informado no **Header** _Authorization_ de cada requisição à API.
      operationId: requestOAuthToken
      responses:
        '200':
          description: Criação ou atualização de token com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  idToken:
                    type: string
                    description: Token de autenticação. Deve ser informado no campo Auhtorization de cada endpoint da API.
                    example: eyJraWQiOiJIWTlqQk43Y2pJajYzN2RobUZ6
                  expiresIn:
                    type: string
                    description: Tempo de expiração do token em segundos.
                    example: '300'
                description: Objeto que representa os dados de autenticação OAuth2
        '400':
          description: Mensagem do cliente não segue a especificação.
          content:
            application/json:
              examples:
                invalid_argument:
                  value:
                    code: 3
                    message: Mensagem do cliente não segue a especificação
                    details: []
                failed_preconditions:
                  value:
                    code: 9
                    message: Request with invalid data
                    details:
                    - '@type': type.googleapis.com/google.rpc.BadRequest
                      fieldViolations:
                      - field: loggi_key
                        description: invalid format
              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: Acesso não autorizado
                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:
      - OAuth2Token
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: 'Código numérico referente à falha.

            INVALID_ARGUMENT = 3

            NOT_FOUND = 5

            PERMISSION_DENIED = 7

            RESOURCE_EXHAUSTED = 8

            FAILED_PRECONDITION = 9

            INTERNAL = 13

            UNAVAILABLE = 14

            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: []
  securitySchemes:
    OAuth2:
      type: oauth2
      description: Autenticação OAuth 2.0 para clientes da API.
      flows:
        clientCredentials:
          tokenUrl: https://api.loggi.com/oauth2/token
          scopes: {}
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-provenance:
  method: harvested
  publisher: Loggi
  source: https://docs.api.loggi.com/openapi/6a554c85514a53bd0f94aaaa
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)