> 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ti0-7.gitbook.io/fidelidade/introducao.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.