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

# API E-BOX

Documentação para acessar API da CliqueRetire

## Introdução

O Objetivo dessa documentação é apresentar de maneira rápida e objetiva como desenvolver uma integração com a Clique Retire. Os serviços disponíveis em nossa API estão exibidos no menu a esquerda e descrição de cada parâmetro assim como exemplos de uso estão disponiveís internamente em cada item.

Está API utiliza requisições HTTP GET, POST, DELETE e o formato JSON para transferência de dados

## Guia rápido

![Diagrama integração e-Commerce com entrega no Hub Clique Retire](https://588294245-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8kTN_5Uh2vXf9daoKG%2F-M8qi8wkuudLaQ8i79dP%2F-M8qiyZZXtEUtL-N-JYu%2FDiagramaIntegrac%CC%A7a%CC%83oHub.jpg?alt=media\&token=5fd24fa0-90f5-4b5a-a245-2697adbb5300)

## Autenticação <a href="#autenticacao" id="autenticacao"></a>

```
header: {
    Content-Type: application/json,
    api-id: string,
    api-key: string
}
```

## Códigos globais de erros <a href="#codigos-globais-de-erros" id="codigos-globais-de-erros"></a>

| **Code** | **Description**               |
| -------- | ----------------------------- |
| 400      | Parameter error               |
| 401      | UserToken expired or Invalid  |
| 403      | User does not have permission |
| 404      | Resource not found            |
| 409      | Conflict or already exists    |
| 500      | Server error                  |