Interface de Fidelidade - APIs de integração

Interface de Fidelidade - APIs de integração

Sobre o produto - APIs de Fidelidade 

A Presence possui um conjunto de API's que disponibilizam o acesso externo ao Módulo de Fidelidade com o intuito de transmitir/receber dados dos processos específicos.

O token de acesso à outras APIs não permite o uso deste conjunto, uma vez que estão associadas a módulos extras.

Para ter acesso aos métodos consulte as condições comerciais para essa contratação adicional.

Os envolvidos

Todo processo de integração envolve empresas com responsabilidades claras e definidas.

Presence
A Presence é responsável pelas API's  (Presence API) onde estarão disponibilizados os métodos de entrada e saída de dados, normalmente envolvendo os processos de fidelidade.
Deve garantir que os dados requisitados ou postados sejam efetivados.
É também responsável pela homologação básica do Integrador (Middleware)

Integrador
É a empresa que desenvolve um conector  (Middleware) que permite envio e recebimento de dados o  entre ERP e Plataforma de modo automático e seguindo as regras de emparelhamento estabelecidas.

É responsável pelo fluxos e controle de tráfego entre plataforma e ERP e pode ser feito pela equipe da plataforma, do site ou por terceiros.

Visão Geral

A API Fidelidade possui endpoints com os quais serão possíveis:
  1. autenticação/autorização;
  2. consulta de dados;
  3. inclusão/atualização de dados.
Todos os dados enviados e recebidos pela API estão/deverão ser em formato JSON (application/json).

Orientações Técnicas

Para entender os chamadas de endpoints do API FIDELIDADE, consulte: Presence API - Orientações Técnicas

Métodos da API para Integração

Integração
arquivo com o projeto para o Postman está anexado (download) com todos os métodos e modelos de integração, cada Endpoint tem o Token e os tipos de consultas ou integrações que podem ser realizadas.

Consulta de dados

  1. API FIDELIDADE_EXTRATO
  2. API FIDELIDADE_SALDO

Entrada de Dados

  1. API FIDELIDADE_GERAR_VOUCHER

Ver também