API Tegge v1
  1. Introdução a API
API Tegge v1
  • Tegge FGTS
    • Inicio
    • Aplicação
    • Web
    • API
    • Formalização
    • Suporte
  • Introdução a API
    • Casos de uso
    • Ambientes
    • Autenticação
  • Endpoints
    • Sandbox
      • Token
      • Consulta de saldo
      • Consulta de taxas
      • Simulação
      • Inserir proposta
      • Consulta de propostas
  1. Introdução a API

Casos de uso

image-tegge
Este documento tem como objetivo orientar os parceiros Tegge na configuração e utilização dos serviços da API. O documento possui termos técnicos e é voltado para profissionais da área de TI com conhecimento em projeto e desenvolvimento de sistemas.
Esta API foi documentada utilizando o formato OpenAPI e foi baseada no exemplo Petstore, fornecido pela equipe swagger.io.

Casos de Uso | Consulta de proposta#

Vantagens#

Aumentar a segurança e a confiabilidade de cada operação.
Reduzir o tempo da equipe de vendas e de backoffice.
Aumentar o conhecimento deste tipo de operação para mais áreas da empresa.

Situações de uso#

Confirmação da venda no ERP
Fechamento do caixa
Dashboards / DataViz
Integração Ecommerce e Marketplace
Integração em softwares proprios

Dados enviados na Consulta de Proposta#

ID da Proposta
Número da Proposta
Data da Proposta
Quantidade de Saques-Aniversário na proposta
Valor da Compra (Valor Líquido)
Valor Bruto
CPF do Cliente
Nome do Cliente
Situação (status) da Proposta
Nome do Agente

Processos#

Para acessar qualquer endpoint, é fundamental passar por um processo de autenticação que garante a obtenção de um token válido por 1 hora.
Para gerar esse token, siga as instruções detalhadas na seção Autenticação.
Modified at 2024-08-15 12:57:51
Previous
Suporte
Next
Ambientes
Built with