> For the complete documentation index, see [llms.txt](https://ti0-7.gitbook.io/fidelidade/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ti0-7.gitbook.io/fidelidade/introducao.md).

# Introdução

{% hint style="info" %}
**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 *<ti@fidelizarmais.com.br>*
{% endhint %}

## Primeiros passos

Nós temos dois ambientes de API:

* ***Testes***
  * &#x20;<https://sandbox.fidelizarmais.com>,&#x20;
  * *para prêmios:* <https://sandbox.fidelizarmais.com>,&#x20;
  * *para autenticação:* [https://sandbox-oauth.fidelizarmais.com](https://sandbox-oauth.fidelizarmais.com/)
* ***Produção**:*
  * &#x20;[*https://gateway.fidelizarmais.com*](https://gateway.fidelizarmais.com/)*,*&#x20;
  * *para prêmios:* [*https://gateway-awards.fidelizarmais.com*](https://gateway-awards.fidelizarmais.com)*,*&#x20;
  * *para autenticação:* [*https://gateway-oauth.fidelizarmais.com*](https://gateway-oauth.fidelizarmais.com/)*,*
  * para resgate: [*https://gateway.fidelizarmais.com*](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](https://painel.fidelizarmais.com/oauth/auth) 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 ***<ti@fidelizarmais.com.br> i***&#x6E;formando o motivo da integração;
* ***Authorization*** (é um token Jwt que será necessário somente nos endpoints que contém "private" na URI).

{% hint style="warning" %}
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.&#x20;
{% endhint %}

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...

{% content-ref url="/pages/ndVWXaUxI1QhCUr0njR2" %}
[StatusCode](/fidelidade/detalhes.../statuscode.md)
{% endcontent-ref %}

{% content-ref url="/pages/mDIplSUSVTppLUiyOeQX" %}
[Idiomas](/fidelidade/detalhes.../idiomas.md)
{% endcontent-ref %}

## + módulos

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

{% content-ref url="/pages/Ftg7BhadVD0bISNFToY8" %}
[Lista de dados](/fidelidade/modulos/lista-de-dados.md)
{% endcontent-ref %}

{% content-ref url="/pages/CJ23sCPHO9SH2l1LR9Et" %}
[Clientes](/fidelidade/modulos/clientes.md)
{% endcontent-ref %}