👋Introdução

Aqui você vai entender como utilizar a API do +fidelidade de uma maneira simples e intuitiva.

Nota: Essa documentação mostra o essencial da nossa API. Caso você queira fazer algo direferente do que está aqui ou precisa de mais ajuda entre em contato com [e-mail]

Primeiros passos

Nós temos dois ambientes de API:

• Testes

  • https://sandbox.fidelizarmais.com,

  • para prêmios: https://sandbox.fidelizarmais.com,

  • para autenticação: https://sandbox-oauth.fidelizarmais.com

• Produção:

  • https://gateway.fidelizarmais.com,

  • para prêmios: https://gateway-awards.fidelizarmais.com,

  • para autenticação: https://gateway-oauth.fidelizarmais.com,

  • para resgate: https://gateway.fidelizarmais.com.

Para fazer qualquer requisição nesses dois ambientes, é necessário que no header seja informado:

• store-key (que é o id da loja no +fidelidade que no painel em: Mais > Configurações > Loja > Chave de API);

• secret-key (que é um id passado pela equipe fidelizar+), você pode solicitar uma secret enviando um e-mail para [e-mail] informando o motivo da integração;

• Authorization (é um token Jwt que será necessário somente nos endpoints que contém "private" na URI).

Todas as requisições que contém "public" ou "protected" no endpoint só precisam desses dois parâmetros no header, pois são requisições públicas.

Nessa documentação todos os endpoints utilizam o ambiente de testes, para apontar para o ambiente de produção basta trocar de https://sandbox.fidelizarmais.com para https://gateway.fidelizarmais.com, colocar o id da loja real no store-key e uma secret-key de produção fornecida pela equipe Fidelizar+.

É bom saber: a API só é liberada caso a loja tenha contratado essa funcionalidade.

+ detalhes...

🆗pageStatusCode🇧🇷pageIdiomas

+ módulos

Aqui estão alguns exemplos de por onde começar na api do +fidelidade.

⚙️pageLista de dados👥pageClientes