Fulfillment - Manual da API
    Fulfillment - Manual da API
    • 🚀 Introdução
    • 🔒 Autenticação
    • 🚦 Rate Limiting
    • Autenticação
      • Autenticação
      • Sessão do usuário
      • Refresh Token
      • Finalizar Sessão
    • Produtos
      • 📦 Conceitos de Produtos
      • Gerenciamento
        • Coleção de produtos
        • Criar um novo produto
        • Detalhes do produto
        • Estoque do Produto
        • Modificar Produto
        • Excluir Produto
      • Controle
        • Controle de Temperatura
        • Controle de Estoque
        • Data de validade & Lote
      • Códigos fiscais
        • Códigos Fiscais de Produtos
        • Códigos fiscais
        • Código fiscal
        • Código fiscal
        • Código fiscal
        • Código fiscal
      • RMA
        • Estatísticas
        • Qualidade
        • Ocorrências
    • Tipos de Operações
      • ♻️ Tipos de Operação
      • 📦 Entrada de Mercadoria
      • Tipos de Operações
      • Tipo de Operação
    • Clientes
      • 👔 Clientes & Parceiros
      • Gerenciamento
        • Coleção de Clientes
        • Novo cliente
        • Detalhes
        • Modificar
        • Excluir
      • Endereços
        • Endereços
        • Adicionar Endereço
        • Detalhes do Endereço
        • Modificar Endereço
    • Pedidos - Gerenciamento
      • 🛒 Pedidos Fulfillment
      • Gerenciamento
        • Pedidos
        • Novo Pedido
        • Detalhes do Pedido
        • Confirmar Pedido
        • Update Order
      • Workflows
        • Situação atual de um pedido
        • Fluxos de execução disponíveis
        • Avançar Workflow
        • Cancelar Pedido / Workflow
      • Itens do Pedido
        • Gerenciamento
          • Itens do Pedido
          • Adicionar Item
          • Detalhes do Item
          • Modificar Item
          • Excluir Item
        • Rastreamento
          • Rastreamentos
          • Adicionar Rastreamento
          • Detalhes do Rastreamento
          • Excluir Rastreamento
      • Agendamento
        • Agendamento
        • Slots Disponíveis
        • Reservar Slots
        • Cancelar Agendamento
        • Confirmar Agendamento
      • Identificação de Produtos
        • Etiquetas
        • Gerar Etiquetas
        • Confirmar impressão
      • Documentos Fiscais
        • Documentos Fiscais
        • Documento Fiscal
        • Detalhes do Documento
        • Excluir Documento
      • Documentos para Impressão
        • Documentos
        • Adicionar Documento
        • Detalhes do Documento
        • Pré-visualização
        • Excluir Documento
    • Pedidos - Aguardando NFe
      • Totais
      • Aguardando NFe
      • Detalhes Fiscal
    • Configurações
      • Webhooks
        • Webhooks
        • Webhook
        • Webhook
        • Webhook
        • Webhook
        • Histórico
        • Estatísticas
        • Teste
        • Eventos Disponíveis
      • Enumeração
        • Enumeração
        • Tipos disponíveis
      • Token de API
        • Token de API
        • Criar um novo Token
    • Locais de Estoque
      • Localizações Exclusivas
      • Ocupação das Localizações
      • Detalhes de uma Localização
      • Produtos de uma Localização
    • Inventário
      • Resumo Geral do Estoque
      • Inventário Detalhado
      • Produtos com Estoque Baixo
      • Consulta Detalhada de Estoque

    🔒 Autenticação

    Nesta seção, você aprenderá como autenticar-se na API, renovar tokens e acessar recursos protegidos com segurança.

    🔑 Métodos de Autenticação#

    A API oferece dois métodos de autenticação via Bearer Token:

    Método 1: Token Permanente#

    Ideal para: Integrações de produção e sistemas automatizados
    Após o cadastro na plataforma:
    1.
    Acesse o Painel do Vendedor
    2.
    Navegue até a aba API
    3.
    Gere um Token Permanente (recomendado para integrações)
    4.
    Anote o token em local seguro (não será mostrado novamente)

    Método 2: Login com Email/Senha#

    Você pode obter um token de acesso temporário, com validade de 24 horas, utilizando suas credenciais.

    Exemplo de resposta#

    Junto ao token, é fornecido um refresh token, que permite renovar a sessão automaticamente, sem a necessidade de informar o e-mail e a senha novamente.
    ⚠️ Limitações importantes:
    Token expira em 24 horas
    Requer renovação periódica via refresh token

    🔄 Renovação de Token (Refresh Token)#

    O refresh token permite renovar o token de acesso sem precisar fazer login novamente. Isso é especialmente útil para aplicações que precisam manter a sessão ativa por períodos prolongados.
    Importante: Para renovar o token, você precisa enviar o Bearer token atual juntamente com o refresh token no corpo da requisição.

    Exemplo de resposta#

    Importante: Sempre que você renovar o token, receberá um novo par de tokens (token de acesso e refresh token). O refresh token antigo será invalidado.

    🚪 Logout#

    Para encerrar a sessão e invalidar o token, utilize o endpoint de logout:

    👤 Informações do Usuário#

    Para obter informações do usuário autenticado:

    📍 Rotas de Autenticação#

    A seguir estão as rotas disponíveis para autenticação na área do cliente:
    MétodoRotaDescrição
    POST/api/v1/auth/loginAutentica o usuário e retorna tokens de acesso
    POST/api/v1/auth/refreshRenova o token de acesso usando o refresh token
    POST/api/v1/auth/logoutInvalida o token de acesso atual
    GET/api/v1/auth/meRetorna informações do usuário autenticado

    📊 Fluxos de Autenticação#

    Fluxo 1: Autenticação via Email/Senha#

    Fluxo 2: Renovação de Token#

    Fluxo 3: Acesso a Recursos Protegidos#

    Modified at 2025-08-29 14:19:47
    Previous
    🚀 Introdução
    Next
    🚦 Rate Limiting
    Built with