> ## 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.

# Démarrage rapide

> Fais ton premier appel à l'API partenaire Aniva en quelques minutes : trouve un lieu de test, crée un profil et réserve une prise de sang.

Ce guide te présente le flux principal : trouver un lieu de test, créer un profil patient, planifier un rendez-vous et confirmer une prise de sang.

## Prérequis

Tu as besoin d'une clé API partenaire délivrée par Aniva.

> [!NOTE]
>
> Si tu n'as pas encore de clé API, contacte Aniva pour en obtenir une pour ton compte partenaire.

## Étapes

**1. Lister les lieux disponibles**

Récupère la liste des lieux de test pour trouver un `location_id` pour le rendez-vous que tu vas planifier.

```bash theme={null}
curl https://anivahealth.com/api/v1/locations \
  -H "x-api-key: YOUR_API_KEY"
```

**Exemple de réponse**

```json theme={null}
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Aniva Berlin Mitte",
    "company_name": "Aniva GmbH",
    "street": "Unter den Linden",
    "house_number": "42",
    "address_line_2": null,
    "city": "Berlin",
    "state": "Berlin",
    "postal_code": "10117",
    "country_name": "Germany",
    "country_code": "DE",
    "timezone": "Europe/Berlin",
    "contact_phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com",
    "website": "https://anivahealth.com",
    "google_maps_url": null,
    "image_url": null,
    "open_hours": {
      "monday": [{ "open": "08:00", "close": "18:00" }],
      "tuesday": [{ "open": "08:00", "close": "18:00" }],
      "wednesday": [{ "open": "08:00", "close": "18:00" }],
      "thursday": [{ "open": "08:00", "close": "18:00" }],
      "friday": [{ "open": "08:00", "close": "16:00" }],
      "saturday": [],
      "sunday": []
    }
  }
]
```

Note l'`id` du lieu que tu souhaites utiliser. Tu en auras besoin à l'étape 3.

**2. Créer un profil**

Crée un profil patient en envoyant ses données démographiques. Le champ `profile_group` relie le profil à ton compte partenaire — il accepte soit l'UUID immuable du groupe, soit son slug lisible.

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/profiles \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jordan",
    "last_name": "Rivera",
    "sex": 1,
    "date_of_birth": "1990-04-15",
    "profile_group": "your-profile-group"
  }'
```

**Champs du corps de la requête**

| Champ | Type | Requis | Description |
| - | - | - | - |
| `first_name` | string | Oui | Prénom du patient |
| `last_name` | string | Oui | Nom de famille du patient |
| `sex` | integer | Oui\*\* | `1` = masculin, `2` = féminin (ISO/IEC 5218) |
| `date_of_birth` | string | Oui\*\* | Date de naissance au format `YYYY-MM-DD`. Doit être dans le passé, pas avant 1900, et correspondre à un âge de 16 à 100 ans. |
| `profile_group` | string | Oui\* | UUID ou slug de ton groupe de profils partenaire. L'UUID est la référence stable ; le slug est également accepté. |
| `profile_group_slug` | string | Non | **Déprécié.** Alias slug pour `profile_group`. `profile_group` ou `profile_group_slug` est requis. |
| `email` | string | Non | Adresse e-mail du patient. Générée automatiquement si omise. |
| `language` | string | Non | `en`, `de` ou `fi`. Par défaut `en`. |
| `phone` | string | Non | Numéro de téléphone au format E.164, par exemple `+4915123456789`. |
| `height` | number | Non | Taille en centimètres. |
| `weight` | number | Non | Poids en kilogrammes. |
| `transactional_emails_enabled` | boolean | Non | Remplace le paramètre par défaut du groupe de profils pour les e-mails opérationnels. |
| `marketing_emails_enabled` | boolean | Non | Remplace le paramètre par défaut du groupe de profils pour les e-mails marketing. |

\*\* Facultatif lorsque ton groupe de profils laisse le patient saisir les deux sur la page d'activation du kit. Voir
[Profils](https://docs.anivahealth.com/fr/concepts/profiles.md#laisser-le-patient-saisir-sa-date-de-naissance-et-son-sexe).

**Exemple de réponse (201 Created)**

```json theme={null}
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "handle": null,
  "first_name": "Jordan",
  "last_name": "Rivera",
  "email": "jordan.rivera@example.com",
  "phone": null,
  "sex": 1,
  "date_of_birth": "1990-04-15",
  "height": null,
  "weight": null,
  "language": "en",
  "transactional_emails_enabled": null,
  "created_at": "2026-04-01T10:00:00Z",
  "updated_at": null
}
```

Note l'`id` de la réponse. Tu l'utiliseras comme `profile_id` à l'étape suivante.

**3. Planifier un rendez-vous**

Crée un rendez-vous en utilisant le `profile_id` de l'étape 2 et le `location_id` de l'étape 1. Définis `scheduled_at` sur un début de créneau retourné par [Obtenir les disponibilités](https://docs.anivahealth.com/fr/api/locations/get-availability.md) pour ce lieu. L'API rejette toute heure qui ne figure pas dans la grille de créneaux.

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/appointments \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "location_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "scheduled_at": "2026-04-10T09:00:00Z"
  }'
```

**Exemple de réponse (201 Created)**

```json theme={null}
{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "location_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "scheduled_at": "2026-04-10T09:00:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "created_at": "2026-04-01T10:05:00Z",
  "updated_at": null,
  "profile": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "handle": null,
    "first_name": "Jordan",
    "last_name": "Rivera",
    "email": "jordan.rivera@example.com",
    "phone": null,
    "sex": 1,
    "date_of_birth": "1990-04-15",
    "height": null,
    "weight": null,
    "language": "en",
    "transactional_emails_enabled": null,
    "created_at": "2026-04-01T10:00:00Z",
    "updated_at": null
  },
  "panels": [],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

Note l'`id` du rendez-vous. Tu l'utiliseras pour confirmer la prise de sang.

**4. Confirmer la prise de sang**

Une fois la prise de sang terminée, soumets le code laboratoire (code-barres du tube) pour confirmer la prise de sang et déclencher le pipeline de commande de laboratoire. Si les tubes d'une prise de sang portent plusieurs codes, envoie `lab_codes` à la place — voir [Confirmer la prise de sang](https://docs.anivahealth.com/fr/api/appointments/confirm-blood-draw.md).

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/appointments/c3d4e5f6-a7b8-9012-cdef-123456789012/confirm \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lab_code": "7642001234"
  }'
```

**Exemple de réponse (200 OK)**

```json theme={null}
{
  "success": true
}
```

Après confirmation, le pipeline de commande de laboratoire est déclenché. Tu peux récupérer le rendez-vous pour vérifier que son statut est passé à `"blood_drawn"`.

## Étapes suivantes

* [Ajouter des panels à un rendez-vous](https://docs.anivahealth.com/fr/api/appointments/add-panels.md) pour préciser quelles analyses de laboratoire effectuer.
* [Mettre à jour un rendez-vous](https://docs.anivahealth.com/fr/api/appointments/update-appointment.md) pour le reprogrammer ou changer de lieu avant la prise de sang.
* [Annuler un rendez-vous](https://docs.anivahealth.com/fr/api/appointments/cancel-appointment.md) s'il n'est plus nécessaire.
* [Obtenir les résultats de laboratoire](https://docs.anivahealth.com/fr/api/appointments/get-results.md) pour récupérer les résultats cliniques et génétiques après traitement.
* [Télécharger des documents](https://docs.anivahealth.com/fr/api/documents/download-document.md) pour récupérer les rapports de laboratoire en PDF.
* [Récupérer un profil](https://docs.anivahealth.com/fr/api/profiles/get-profile.md) pour vérifier ou afficher les données du patient.
* Consulter la [référence API](https://docs.anivahealth.com/fr/api/profiles/create-profile.md) complète pour connaître tous les endpoints et paramètres disponibles.


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