Integração · API
Maçadora de propósito.
REST sobre HTTPS, JSON à entrada e à saída, versões datadas, escritas idempotentes e erros que lhe dizem que campo estava mal. Além dos recursos aqui não há nada para aprender, e é essa a intenção.
- RESTsobre HTTPS
- 24 hjanela de idempotência
- 90 diasaviso de retirada
Contrato
As partes em que vai confiar
- Versões
- Datadas, fixadas por chave
- Idempotência
Idempotency-Key, 24 horas- Erros
- Por campo, legíveis por máquina
- Limites de frequência
- Por chave, cabeçalhos em cada resposta
- Autenticação
- Chave Bearer, só do lado do servidor
- Relógio
- UTC, RFC 3339
Uma chave fica fixada a uma versão. As versões novas não lhe chegam até que você se mova, e uma versão mantém-se pelo menos 90 dias desde o anúncio da sua sucessora.
Repetir uma criação devolve a verificação original. Uma tempestade de novas tentativas durante um incidente não pode abrir cinco verificações sobre um jogador.
Um 422 nomeia o campo e a regra incumprida. Nada devolve um 400 pelado com prosa no corpo.
O remanescente e o momento de reinício estão sempre presentes: um cliente pode travar antes de lhe ser dito para parar.
As chaves nunca chegam a um navegador nem a um telemóvel; o cliente recebe em vez disso fichas de passo de curta duração.
Cada marca temporal em cada carga e cada processo, sem variantes em hora local.
Recursos
A superfície, completa
| Método e caminho | Faz | Idempotente |
|---|---|---|
POST /v1/checks | Abre uma verificação para uma pessoa num mercado | Sim, 24 h |
GET /v1/checks/{id} | Estado actual, veredicto e motivos | — |
POST /v1/checks/{id}/cancel | Abandona uma verificação que ainda está a recolher | Sim |
GET /v1/evidence/{id} | O processo selado por trás de um veredicto | — |
GET /v1/events | O diário, para tudo o que um webhook não conseguiu entregar | — |
POST /v1/policies | Publica uma versão de política para um mercado | Sim |
POST /v1/exclusions | Publica o seu ficheiro de autoexclusão, onde você é a fonte com autoridade | Sim |
Sete recursos. Uma API de verificação que precise de mais está normalmente a expor a sua própria estrutura interna em vez do seu problema.
Decisões
Por que razão tem esta forma
Por que razão a resposta não é transmitida em fluxo?
Porque a parte lenta é o jogador, não nós. Uma verificação espera que uma pessoa encontre o passaporte; manter uma ligação aberta para isso é um custo para você e uma fragilidade para ambos. O webhook existe exactamente por isto.
Por que razão o veredicto não inclui uma pontuação?
Inclui as pontuações de cada sinal, no processo. O que não faz é reduzi-las a um número único, porque o número único é justamente o que depois não se consegue explicar a um supervisor.
Podemos associar uma política a uma verificação retroactivamente?
Não. Uma verificação anota a versão de política que a decidiu, e esse dado é imutável. Voltar a decidir sob uma política nova abre uma verificação nova que remete para a antiga.