Para quem olha um catálogo e pensa “API”

Sua coleção pode sair do app. Com educação.

O KolleK tem uma API JSON documentada para quem quer conectar a coleção a um script, a um painel, a um processo de importação próprio ou a algo maravilhosamente específico.

Primeiros passos

Introdução

Autenticação

Paginação

Limites de taxa

Recursos

GET Listar itens
GET Obter item
POST Criar item
GET Listar coleções
GET Listar localizações
GET Listar tipos de coleção
GET /api/items GERADO DO CÓDIGO

Listar itens

Recupere itens de todas as coleções ou limite a lista a uma coleção com o parâmetro de consulta collection. Retorna uma lista paginada de objetos item.

Parâmetros de consulta

collection string opcional
per_page integer opcional
page integer opcional

Chaves de API pessoais

O mesmo catálogo, disponível para as suas ferramentas.

Use uma chave de API pessoal para ler e gerenciar a coleção com requisições HTTP simples. Coleções, itens, cópias, histórico, localizações e o resto não ficam presos atrás da interface.

collections items copies history locations item-types
Criar chave de API Configurações · Desenvolvedor

Nome

Sincronização do painel da casa
Sua nova chave Copiar

14|aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aK

Copie agora. Esta é a única vez que a chave completa será mostrada.

Referência

Documentação que vem do produto.

A referência da API é gerada a partir do código. Isso significa que a documentação dos endpoints é feita para ficar perto do que o app realmente suporta, em vez de derivar para uma ficção arqueológica.

cURL JavaScript PHP Requisição
curl https://kollek.example/api/items \
-H "Authorization: Bearer $KOLLEK_KEY" \
-G --data-urlencode "collection=17" \
--data-urlencode "per_page=2"
200 OK Resposta · application/json
{
"data": [
{ "id": 512,
"name": "Kind of Blue",
"location": "Shelf B2" }
],
"links": { "next": "…?page=2" },
"meta": { "current_page": 1, "total": 128 }
}
Paginação por página (links + meta) 60 requisições / min por usuário Autenticação por token Bearer

Interoperabilidade

Uma saída, de propósito.

Precisa analisar seu catálogo em outro lugar? Montar um relatório privado? Levar informações para outro fluxo de trabalho? A API te dá uma saída limpa sem tornar o produto menos útil por dentro.

API do KolleK

kollek.app/api

Seu catálogo

Um script privado

Leia o catálogo em um agendamento e faça algo específico com ele.

Seu próprio painel

Traga itens e localizações para uma visão que você mesmo criou.

Uma planilha

Exporte uma fatia da coleção quando outra ferramenta precisar dos dados.

Webhooks

Webhooks: relatório de status honesto.

Hoje você pode registrar endpoints de webhook assinados. Os eventos do produto ainda não disparam entregas. Não vamos chamar isso de “em breve” e torcer para você deduzir o resto.

Endpoints de webhook 1 registrado
https://hooks.mydash.io/kollek Ocioso
Segredo de assinatura whsec_••••••8d2f
Esquema de assinatura HMAC-SHA256
Entregas 0
O registro de endpoints e a assinatura já funcionam. Nenhum evento do produto dispara uma entrega ainda, então este endpoint ficará ocioso até isso acontecer.

Leia a referência. Construa aquilo que você realmente queria.

Endpoints, autenticação, paginação e limites de taxa, gerados a partir do código e prontos para a sua chave.

Explorar a referência da API

O KolleK pode (ainda) não ser para você se…

Você precisa de integrações prontas com todo serviço que existe.

Você precisa de webhooks orientados a eventos hoje. Os endpoints e a assinatura existem, mas nenhum evento do produto os dispara ainda.

Escolha o KolleK quando…

Você quer uma API JSON documentada para as suas próprias ferramentas e scripts.

Você precisa de acesso direto e autenticado por token ao catálogo agora.

Atualizaremos esta página quando o produto mudar. A página de status dos recursos tem os detalhes chatos, mas importantes.