Para parceiros e compradores

REST API

Numa frase

Uma API REST é a interface que um fornecedor disponibiliza para que o teu software possa pedir análises, ler estados e obter resultados em código. É o caminho que a maioria das equipas de produto e engenharia escolhe para uma integração.

Uma API REST é um conjunto de endereços web que um fornecedor publica para que o teu software possa pedir algo e receber uma resposta estruturada. O teu sistema autentica-se, envia um pedido, como a encomenda de um painel, e lê a resposta em código. A API da Aniva usa um cabeçalho de chave API, um cabeçalho de idempotência para novas tentativas seguras e uma sandbox com dados de teste, e a documentação está em docs.anivahealth.com.

A interface importa numa avaliação porque define quanto trabalho os teus engenheiros fazem uma vez e quanto a tua equipa de operações repete manualmente todos os dias. Uma sandbox permite que os teus programadores experimentem a interface antes de o contrato ser assinado, que é a forma mais barata de descobrir o quão boa é.

  • Pede o URL da documentação e lê-a antes da primeira chamada técnica.
  • Pergunta se existe uma sandbox com dados de teste e como a tua equipa obtém uma conta.
  • Pergunta como são tratados os pedidos repetidos, porque uma encomenda nunca deve criar duas amostras.
  • Pergunta o que contém uma resposta de erro quando um pedido é rejeitado.
  • Pergunta como te avisam de uma alteração na interface e durante quanto tempo as versões anteriores continuam a funcionar.

Uma integração não é a única forma de começar, porque a Aniva também tem uma consola de parceiros onde a tua equipa pode trabalhar sem escrever código. Muitos parceiros usam ambas, com a API dentro do seu próprio produto e a consola para a equipa de apoio.

Neste glossário, Webhook explica como uma alteração de estado chega ao teu sistema, enquanto Partner-Portal aborda a opção para uma equipa sem programadores e FHIR aborda a norma que um comprador institucional pode pedir.

Esta entrada do glossário é informação geral, não aconselhamento médico, e não se destina a diagnosticar, tratar ou excluir qualquer condição. Discute os teus próprios resultados com um profissional de saúde que conheça o teu historial.

O teu eu futuro está à espera

Começa a construir a década mais saudável da tua vida.

Começar