Um token de API permite que o seu próprio código comunique com o Ocoya. Encontra-os em Settings → API — Settings está no menu da conta, o avatar no topo da barra lateral.
Esta página explica como gerir tokens. Para saber como chamar a API — o URL base, o cabeçalho, os endpoints — consulte a documentação da API REST.
Comece aqui. O menu da conta é o avatar no topo da barra lateral — Settings e depois API na barra lateral das definições.
Settings → API, com o gráfico de pedidos por cima e os seus tokens por baixo.
Criar um token
Selecione Create token e dê-lhe um nome. O nome serve apenas para si — ajuda-o a distinguir os tokens mais tarde e a revogar o correto.
Dê aos tokens o nome do local onde são usados, não do que fazem. Zapier, staging server, reporting script dizem-lhe o que deixa de funcionar quando o revogar. API key 2 não diz.
Copie o token assim que for criado e guarde-o num local seguro. Depois disso, o Ocoya mostra apenas os primeiros e os últimos caracteres.
O que um token consegue aceder
Cada token pode aceder a todas as marcas pertencentes a esta conta. Não é possível limitar um token a uma única marca — a lista de tokens mostra All brands junto a cada um.
Isto é importante se pretendia dar ao programador de um cliente um token apenas para a marca dele. Não é possível. Ele conseguiria aceder a todas as marcas que possui.
Revogar um token
O menu ⋯ de qualquer token oferece Delete token. A eliminação é imediata e permanente — tudo o que usar esse token começa a falhar de imediato, por isso certifique-se primeiro de que sabe o que o está a usar. É para isso que servem os nomes.
Não é possível rodar um token no mesmo sítio. Para substituir um: crie o novo token, passe a sua integração para ele e só depois elimine o antigo.
Acompanhar a utilização
O gráfico API usage mostra os pedidos autenticados da marca atual, na última hora, no último dia ou nos últimos 30 dias. É a forma mais rápida de confirmar que uma integração está mesmo a chamar o Ocoya, ou de detetar uma que chama muito mais do que esperava.
O Ocoya permite 60 pedidos por minuto por chave e devolve 429 Too Many Requests acima disso. Os detalhes completos, incluindo os cabeçalhos de limite de pedidos, estão em Rate limits.