Documentação KeedPay API

Bem-vindo à documentação oficial da KeedPay!

Ela foi desenvolvida para facilitar a integração com sistemas externos, automatizar processos e ampliar as possibilidades de uso da nossa plataforma.

Sobre

Esta documentação contém tudo o que você precisa para começar: instruções de autenticação, descrição dos principais endpoints, exemplos de requisições e respostas, além de boas práticas para uso.

Endpoints

Este é o endpoint padrão da API Keed

https://api.keedpay.com.br/api/v1/

Padrão de resposta

Se o valor de process for false, o body da resposta retornará uma string com a mensagem de erro. Caso process seja true, o body da resposta conterá os dados definidos na rota correspondente.

Paginação

Por padrão a API retornará 25 resultados por página.

"pagination": {
    "page_size": 25
    "total_pages": 50
    "total_count": 100
}

Atenção: O objeto "pagination" é retornado apenas na primeira página

Cache

Por padrão, algumas rotas GET utilizam cache para otimizar a performance das requisições. Para identificar se uma rota está utilizando cache, verifique o valor do X-CACHE no header da requisição.

Se o valor for HIT, significa que a resposta foi obtida a partir do cache.

Se o valor for MISS, a resposta foi gerada diretamente pela API, sem uso de cache.