> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Créer une session d'intégration

> Obtenir une URL à usage unique qui affiche les résultats de laboratoire d'un profil dans ton application

Obtiens une URL qui affiche les résultats de laboratoire d'un profil sur une page en lecture seule. Ouvre l'URL dans une WebView de ton application ou dans un onglet de navigateur. Appelle cet endpoint depuis ton serveur chaque fois que l'utilisateur ouvre les résultats et ne mets jamais l'URL en cache.

Nécessite les scopes `embed` et `results_view` sur un groupe de profils du profil. Aniva accorde le scope `embed` sur demande. Sans l'un de ces deux scopes, la requête renvoie `403`.

> [!NOTE]
>
> L'URL fonctionne une fois et pendant 5 minutes. À son ouverture, la page démarre une session de
> 60 minutes que seule cette page détient. Archive ta clé API pour fermer toutes les pages ouvertes
> d'un coup.

## Requête

### Paramètres de chemin

**id** `string` *required*

Identifiant unique (UUID) du profil dont la page affiche les résultats.

### Corps

Le corps est facultatif. Sans corps, l'URL ouvre la liste des biomarqueurs dans la langue du profil.

**language** `string`

Langue de la page : `en`, `bg`, `ca`, `cs`, `da`, `de`, `el`, `es`, `et`, `fi`, `fr`, `ga`, `hr`, `hu`, `is`, `it`, `lb`, `lt`, `lv`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `tr` ou `uk`. Par défaut : la langue du profil.

**route** `object`

La page qu'ouvre l'URL. Par défaut : `{ "name": "biomarkers" }`. Tout autre `name` renvoie `400`.

**pages disponibles**

**name** `string` *required*

L'une des valeurs suivantes :

* `biomarkers` : la liste de tous les biomarqueurs avec leurs derniers résultats.
* `biomarker` : la page de détail d'un biomarqueur, avec son évolution, ses intervalles et son explication. Nécessite `biomarker_id`.
* `twin` : le corps en 3D avec une note par domaine de santé. L'utilisateur sélectionne un domaine pour voir ses biomarqueurs.

**biomarker\_id** `integer`

Uniquement pour `biomarker`. Le `biomarker_id` du biomarqueur, tel qu'il apparaît dans les résultats, par exemple `104`. Utilise l'ID, pas le slug : un slug peut changer, l'ID reste.

**report** `object`

Limite chaque page à un seul rapport de laboratoire du profil. Par défaut : tous les rapports du
profil. Envoie exactement un des trois ID. La liste, l'évolution d'un biomarqueur et le Twin
n'affichent alors que les résultats de ce rapport, et la page masque le filtre de rendez-vous.
L'utilisateur ne peut pas ouvrir un autre rapport avec cette URL.

**propriétés**

**appointment\_id** `string`

L'`id` d'un rendez-vous du profil. Ta clé doit y avoir accès, comme pour
[Obtenir les résultats de laboratoire](https://docs.anivahealth.com/fr/api/appointments/get-results.md). Sinon, ce point de
terminaison renvoie `404`, pas `403`.

**home\_kit\_order\_id** `string`

L'`id` d'une commande de kit à domicile du profil. Ta clé doit y avoir accès, comme pour
[Obtenir les résultats de laboratoire](https://docs.anivahealth.com/fr/api/home-kit-orders/get-results.md) pour les commandes
de kit à domicile, et nécessite aussi `home_kit_orders_view` ou `home_kit_orders_manage`.

**document\_id** `string`

L'`id` d'un rapport de laboratoire que tu as importé pour le profil avec
[Importer un document](https://docs.anivahealth.com/fr/api/documents/upload-document.md). Ta clé doit y avoir accès, comme pour
[Obtenir les résultats du document](https://docs.anivahealth.com/fr/api/documents/get-document-results.md). Sinon, ce point de
terminaison renvoie `404`, pas `403`. La page affiche la date de l'analyse, ou la date
d'import lorsqu'aucune valeur n'est encore lue. Tant qu'Aniva lit le document et ne dispose
encore d'aucune valeur, chaque page indique à l'utilisateur de la rouvrir dans quelques
minutes.

**appearance** `object`

L'apparence de la page. L'API l'ajoute à l'URL sous forme de paramètres de requête.

**propriétés**

**theme** `string`

`light` ou `dark`. Par défaut : le réglage système de l'appareil.

**primary\_color** `string`

Couleur hexadécimale des boutons et des liens, à 3 ou 6 chiffres, avec ou sans `#`, par
exemple `0f766e`. Par défaut : la couleur de marque de ton groupe de profils, sinon l'orange
Aniva. Les boutons gardent un texte blanc, choisis donc une couleur foncée.

**show\_logo** `boolean`

Affiche le logo de ton groupe de profils au-dessus des résultats. Par défaut : `true`.

> [!TIP]
>
> Tu peux aussi ajouter toi-même les paramètres d'apparence à une URL renvoyée, avant le fragment
> `#token=` : `theme=light|dark`, `primary=<hex>` et `logo=0`. La page ignore toute valeur
> invalide. L'image du logo provient toujours de ton groupe de profils, jamais de l'URL.

## Réponse

En cas de succès, l'API renvoie `201 Created`.

**url** `string` *required*

L'URL de la page. Le jeton de lancement se trouve dans le fragment `#token=`, de sorte qu'un
navigateur ne l'envoie jamais à un serveur. Ouvre-la une fois.

**expires\_at** `string` *required*

Instant au format ISO 8601 après lequel l'URL ne peut plus être ouverte.

La session n'est pas liée à une seule page. Dans la vue intégrée, l'utilisateur peut passer du Twin à un biomarqueur, ainsi qu'entre la liste et les pages de détail. La page affiche uniquement les résultats de laboratoire : elle n'affiche pas les valeurs calculées par Aniva, les fichiers, le chat ni les paramètres.

## Réponses d'erreur

| Statut | Description |
| - | - |
| `400` | Erreur de validation — ID de profil invalide, `route.name` inconnu, `biomarker_id` invalide, couleur invalide, ou `report` ne contenant pas exactement un UUID valide. |
| `403` | Accès refusé — il manque à ta clé API le scope `embed` ou `results_view`, ou le scope de kit à domicile pour un rapport de commande de kit à domicile, ou le profil est hors de ton contexte d'accès. |
| `404` | Profil introuvable, ou aucun biomarqueur n'a ce `biomarker_id`, ou le `report` n'est pas un rendez-vous, une commande de kit à domicile ou un document importé de ce profil, ou le rapport est hors de ton accès. Ce point de terminaison renvoie `404`, pas `403`, afin de ne pas révéler l'existence du rapport. |
| `500` | Erreur interne du serveur. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d/embed-sessions \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "language": "de",
    "route": { "name": "biomarker", "biomarker_id": 104 },
    "report": { "appointment_id": "8d2e4f6a-1b3c-4d5e-9f70-a1b2c3d4e5f6" },
    "appearance": { "theme": "light", "primary_color": "0f766e" }
  }'
```

```bash One uploaded document theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/{id}/embed-sessions \
  --header 'Authorization: Bearer <api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "report": { "document_id": "3f9a7c2e-5d4b-4e1a-8c6f-0b1d2e3f4a5b" }
  }'
```

```json 201 theme={null}
{
  "url": "https://anivahealth.com/de/embed/biomarkers/vitamin-d?theme=light&primary=0f766e#token=eyJwdXJwb3NlIjoiZW1iZWRfbGF1bmNoIi4uLn0.k7Qm2V0sZ1yH",
  "expires_at": "2026-11-19T20:17:43.000Z"
}
```

```json 400 theme={null}
{
  "error": "route.name: Invalid discriminator value. Expected 'biomarkers' | 'biomarker' | 'twin'"
}
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```

```json 404 document theme={null}
{
  "error": "Document not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.