A API Capitão Shop fornece um meio de comunicação entre sistemas eletrônicos via protocolo HTTP (RESTful). Recomendamos a leitura completa para utilização correta da API.
HTTP é o protocolo de comunicação mais utilizado na internet, baseado no modelo requisição-resposta / cliente-servidor, usando métodos HTTP.
Pode ser: obter, cadastrar, alterar ou remover dados — definidos pelos métodos HTTP.
Em uma API RESTful, cada recurso possui um endpoint. Exemplo:
https://minha-api.com.br/v1/clientes
https://api.capitao.shop
| Método | Ação |
|---|---|
| GET | Obter dados |
| POST | Cadastrar novos dados |
| PUT | Alterar dados existentes |
| DELETE | Remover dados |
A API utiliza JSON como padrão de troca de dados. Para métodos POST e PUT, envie o header:
Content-Type: application/json; charset=utf-8
Caso contrário, a API retornará: 415 Unsupported Media Type.
A autenticação é feita com um TOKEN de 64 caracteres, informado como apiKey em todas as requisições.
É gerado no cadastro de usuários do sistema.
Todas as listagens são paginadas. Parâmetros disponíveis:
100)1)Base com 1.020 produtos → 11 páginas com 100 registros por página. Para buscar a página 2:
GET https://api.capitao.shop/v1/produtos?pagina=2
ultima_alteracaoUtilizado para sincronização incremental de dados. Permite filtrar apenas os registros alterados após uma data/hora específica, evitando o download completo da base a cada sincronização.
GET https://api.capitao.shop/v1/clientes?alterado_apos=2022-08-03 15:30:00
A API utiliza o Leaky Bucket Algorithm para controlar o volume de requisições por cliente. Ao ultrapassar o limite, a resposta será:
x-rate-limit-retry-after-seconds: 30