Per a socis i compradors

API REST

En una frase

Una API REST és la interfície que publica un proveïdor perquè el teu programari pugui demanar proves, llegir estats i obtenir resultats mitjançant codi. És la via que trien la majoria d'equips de producte i enginyeria per a una integració.

Una API REST és un conjunt d'adreces web que publica un proveïdor perquè el teu programari pugui demanar alguna cosa i rebre una resposta estructurada. El teu sistema s'autentica, envia una sol·licitud com ara la comanda d'un panell i llegeix la resposta en codi. L'API d'Aniva fa servir una capçalera de clau d'API, una capçalera d'idempotència per a reintents segurs i un entorn de proves amb dades de prova, i la documentació és a docs.anivahealth.com.

La interfície importa en una avaluació perquè decideix quanta feina fan els teus enginyers un sol cop i quanta en repeteix a mà el teu equip d'operacions cada dia. Un entorn de proves permet als teus desenvolupadors provar la interfície abans de signar el contracte, que és la manera més barata de saber com n'és de bona.

  • Demana l'URL de la documentació i llegeix-la abans de la primera trucada tècnica.
  • Pregunta si hi ha un entorn de proves amb dades de mostra i com pot obtenir un compte el teu equip.
  • Pregunta com es gestionen les sol·licituds repetides, perquè una sola comanda no ha de generar mai dues mostres.
  • Pregunta què conté la resposta d'error quan es rebutja una comanda.
  • Pregunta com t'avisen d'un canvi a la interfície i quant de temps continuen funcionant les versions anteriors.

Una integració no és l'única manera de començar, perquè Aniva també disposa d'una consola per a socis on el teu equip pot treballar sense escriure codi. Molts socis fan servir totes dues opcions, amb l'API dins del seu propi producte i la consola per a l'equip de suport.

En aquest glossari, Webhook explica com arriba un canvi d'estat al teu sistema, mentre que Partner-Portal cobreix la via per a un equip sense desenvolupadors i FHIR cobreix l'estàndard que pot demanar un comprador institucional.

Aquesta entrada del glossari és informació general, no consell mèdic, i no té com a objectiu diagnosticar, tractar ni descartar cap afecció. Comenta els teus resultats amb un professional sanitari que conegui el teu historial.

El teu jo futur t'espera

Comença a construir la dècada més saludable de la teva vida.

Comença