API
Catálogo, encomendas e chaves através de uma interface
Traga o nosso catálogo para o seu sistema, desencadeie encomendas e recolha as chaves. Esta página mostra o caminho em seis passos. Os limites, o ambiente de teste e as restrições estão na documentação.
Isto funciona assim que a loja abrir. Até lá, pode ler tudo com calma.
Página para programadores
OpenAPI
Cada pedido está descrito num ficheiro OpenAPI 3.1. Cada número nas páginas é o número que o código impõe.
- BearerUma chave por aplicação, guardada apenas como hash, com validade e rotação
- JSONDinheiro em cêntimos inteiros, datas segundo a ISO 8601, nomes em snake_case
- 120 por minutoleituras para uma chave nova, 600 quando tiver 7 dias
- AssinadoWebhooks com assinatura, opcionalmente também pedidos assinados (RFC 9421)
A API está construída e testada, a documentação está online. As chaves de acesso podem ser criadas assim que a loja abrir. Ainda não existem e estão apenas planeados: um kit de software pronto a usar e um saldo pré-pago.
O que pode fazer com ela
Sincronizar o catálogo
Carregue a lista completa uma vez e, depois, apenas o que mudou desde a sua última sincronização. Uma vista leve mostra apenas o stock.
Pronta, abre com o início das vendasDesencadear encomendas
Uma encomenda por pedido, com um limite de preço, o seu próprio número e uma chave contra compras duplicadas.
Pronta, abre com o início das vendasRecolher chaves
Com uma permissão própria, contadas e registadas. O primeiro pedido põe fim ao direito de livre resolução dessa encomenda.
Pronta, abre com o início das vendasReceber webhooks
Pedidos assinados ao seu servidor quando uma encomenda ou um produto muda. Até 3 endereços.
Pronta, abre com o início das vendasOferecer como vendedor
Manter ofertas, preços e stock a partir do seu sistema de armazém. Isto pressupõe que a venda na Capydra esteja aberta.
Pronta, abre com o início das vendasUtilizar com assistentes de IA
A mesma conta funciona através do nosso servidor MCP. As regras e os limites são os mesmos.
Pronta, abre com o início das vendas
Seis passos até ao primeiro pedido
- 1
Criar uma conta
Inicia sessão na loja.
- 2
Criar uma chave
Em «Chaves API»: um nome, a função (comprador ou vendedor) e as permissões de que precisa. Atribua o menor número possível.
- 3
Confirmar a declaração de renúncia
Duas frases sobre a livre resolução, uma só vez. Cada encomenda feita com a chave remete para elas.
- 4
Guardar a chave em segurança
É mostrada apenas uma vez. Guarde-a como uma palavra-passe e introduza na lista os endereços IP dos seus servidores.
- 5
Definir um limite diário
A soma de todas as encomendas de um dia é limitada: €250 numa chave nova, ajustável até €5,000.
- 6
Enviar o primeiro pedido
Com a chave no cabeçalho «Authorization». O exemplo abaixo lê os primeiros produtos.
O primeiro pedido
Uma chave começa por omk_live_. Segue em cada pedido como valor Bearer. O dinheiro é indicado em cêntimos inteiros e inclui a taxa de serviço.
curl "https://capydra.com/api/v1/catalog/products?page=1" \
-H "Authorization: Bearer omk_live_YOUR_KEY"
# apenas o que mudou desde a sua última sincronização
curl "https://capydra.com/api/v1/catalog/products?updatedSince=2026-11-17T00:00:00Z" \
-H "Authorization: Bearer omk_live_YOUR_KEY"Continuar na documentação
A loja ainda não está aberta: os pedidos que alteram algo respondem com 403 showcase_mode, e as respostas não contêm preços.
Perguntas frequentes
Quanto custa a API?
O acesso não custa nada. Paga as encomendas que desencadear. Não há taxa base.
Existe um kit de software?
Ainda não. A documentação tem exemplos com curl, e o ficheiro OpenAPI pode ser carregado nas ferramentas habituais.
Como obtenho limites mais altos?
Escreva-nos o seu projeto e a sua quantidade. Aumentamos os limites para parceiros em que vemos a necessidade.
O que acontece se a minha chave for roubada?
Bloqueie-a na página de chaves e crie uma nova. Até lá, o limite diário e a lista de IP limitam os danos. Pedidos invulgares bloqueiam a chave automaticamente.
Onde comunico um erro na API?
Através do formulário de contacto com o assunto API. Indique o pedido e a hora.
Pronto para o primeiro pedido?
Leia a página para programadores até ao fim e depois crie uma chave.
Enviar um pedido