> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mycredit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução à API

> A API Mycredit foi desenvolvida para garantir transações com o mais alto nível de segurança, rastreabilidade e confiabilidade. Destinada a empresas e desenvolvedores que necessitam de uma integração robusta e em conformidade regulatória.

<Check>
  Ambiente **Sandbox isolado** para testes de integração.\
  Esse ambiente reproduz o comportamento de produção, permitindo validar fluxos de ponta a ponta com segurança.
</Check>

<Check>
  Documentação em português, com exemplos práticos e alinhados às normas de segurança de transações financeiras.
</Check>

## Requisitos de acesso

* Conta do tipo **revenda** cadastrada em nome do CNPJ da empresa.
* **Token exclusivo da revenda**, fornecido após a validação e aprovação cadastral.

<Info>
  O token é exclusivo da sua empresa.\
  **Nunca compartilhe ou exponha este dado** em repositórios, logs ou sistemas não autorizados.
</Info>

## Ambientes e endpoints

* **Sandbox (teste):** `https://sandboxapi.mycredit.com.br`
* **Produção:** `https://api.mycredit.com.br`

## Autenticação

O processo de autenticação segue o padrão **Bearer Token**.\
Para gerar o segredo de acesso, concatene:

```cs theme={null}
CNPJ_DA_EMPRESA_QUE_EMITIRA_PIX|TOKEN_REVENDA
```

Utilize a barra vertical (pipe) <code>|</code> como divisor de dados da string.

**Exemplo de segredo:**

```
99999999999999|TOKEN123456789123456789123456789
```

<Warning>
  * Utilize sempre o CNPJ da empresa que **efetivamente emitirá o PIX**.
  * O CNPJ da revenda **não deve ser usado**, exceto em situações em que a própria revenda for a emissora do PIX.
</Warning>

**Codificação do Segredo:**

Para garantir a integridade dos dados durante a transmissão, o segredo deve ser convertido para base64 antes de ser utilizado. Esta codificação **não adiciona segurança criptográfica**, mas previne quebras na transmissão de caracteres especiais que podem corromper a autenticação.

**Processo de Autenticação:**

1. **Converta o segredo para base64** utilizando ferramentas seguras
2. **Utilize o segredo codificado** na requisição de autenticação
3. **Receba o Bearer Token** para acessar os endpoints da API

**Requisição de Autenticação:**

```bash theme={null}
curl -H https://sandboxapi.mycredit.com.br/api/token/{SEGREDO_BASE64}
```

<Warning>
  O Bearer Token é obrigatório para todas as chamadas à API.\
  Chamadas sem autenticação ou com credenciais inválidas serão rejeitadas imediatamente.
</Warning>

## Limites de uso (Rate Limits)

<Tip>
  Aplicamos limites de requisições por **chave de autenticação** e **endereço IP**.\
  Em caso de resposta `429 Too Many Requests`, utilize **backoff exponencial** e respeite o cabeçalho `Retry-After`.
</Tip>

## Auditoria e conformidade

* Todos os eventos de transação e autenticação são registrados em nossos servidores, garantindo **rastreabilidade completa**.
* Logs de acesso a dados sensíveis são mantidos em conformidade com requisitos regulatórios e normas de segurança.
* A API segue práticas recomendadas de **segurança bancária e proteção de dados**.