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

# Pika-aloitus

> Tee ensimmäinen Aniva Partner API -kutsusi minuuteissa: etsi testipaikka, luo profiili ja varaa verinäytteenotto.

Tämä opas käy läpi keskeisen työnkulun: testauspisteen etsimisen, potilasprofiilin luomisen, ajanvarauksen tekemisen ja verinäytteenoton vahvistamisen.

## Edellytykset

Tarvitset Anivan myöntämän kumppanin API-avaimen.

> [!NOTE]
>
> Jos sinulla ei vielä ole API-avainta, ota yhteyttä Anivaan saadaksesi sen kumppanitilillesi.

## Vaiheet

**1. Listaa käytettävissä olevat toimipisteet**

Hae luettelo testauspisteistä löytääksesi `location_id`-tunnuksen tekemääsi ajanvarausta varten.

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

**Esimerkkivastaus**

```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": []
    }
  }
]
```

Ota talteen haluamasi toimipisteen `id`. Tarvitset sitä vaiheessa 3.

**2. Luo profiili**

Luo potilasprofiili lähettämällä potilaan perustiedot. `profile_group` yhdistää profiilin kumppanitiliisi — se hyväksyy joko ryhmän muuttumattoman UUID-tunnuksen tai ihmisen luettavissa olevan slugin.

```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"
  }'
```

**Pyynnön rungon kentät**

| Kenttä | Tyyppi | Pakollinen | Kuvaus |
| - | - | - | - |
| `first_name` | string | Kyllä | Potilaan etunimi |
| `last_name` | string | Kyllä | Potilaan sukunimi |
| `sex` | integer | Kyllä\*\* | `1` = mies, `2` = nainen (ISO/IEC 5218) |
| `date_of_birth` | string | Kyllä\*\* | Syntymäaika muodossa `YYYY-MM-DD`. Päivämäärän on oltava menneisyydessä, aikaisintaan vuonna 1900, ja sen perusteella iän on oltava 16–100 vuotta. |
| `profile_group` | string | Kyllä\* | Kumppanin profiiliryhmän UUID tai slug. UUID on pysyvä viite; myös slug hyväksytään. |
| `profile_group_slug` | string | Ei | **Vanhentunut.** Slug-alias kentälle `profile_group`. Joko `profile_group` tai `profile_group_slug` on pakollinen. |
| `email` | string | Ei | Potilaan sähköpostiosoite. Luodaan automaattisesti, jos jätetään pois. |
| `language` | string | Ei | `en`, `de` tai `fi`. Oletus on `en`. |
| `phone` | string | Ei | Puhelinnumero E.164-muodossa, esimerkiksi `+4915123456789`. |
| `height` | number | Ei | Pituus senttimetreinä. |
| `weight` | number | Ei | Paino kilogrammoina. |
| `transactional_emails_enabled` | boolean | Ei | Ohittaa profiiliryhmän oletusasetuksen toiminnallisille sähköposteille. |
| `marketing_emails_enabled` | boolean | Ei | Ohittaa profiiliryhmän oletusasetuksen markkinointisähköposteille. |

\*\* Valinnainen, kun profiiliryhmäsi antaa potilaan syöttää molemmat pakkauksen aktivointisivulla. Katso
[Profiilit](https://docs.anivahealth.com/fi/concepts/profiles.md#anna-potilaan-syoettaeae-syntymaeaika-ja-sukupuoli).

**Esimerkkivastaus (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
}
```

Ota vastauksen `id` talteen. Käytät sitä `profile_id`-arvona seuraavassa vaiheessa.

**3. Tee ajanvaraus**

Luo ajanvaraus käyttämällä vaiheen 2 `profile_id`-tunnusta ja vaiheen 1 `location_id`-tunnusta. Aseta `scheduled_at`-arvoksi vapaan ajan alkamisaika, jonka [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md) palauttaa kyseiselle toimipisteelle. API hylkää ajan, joka ei osu aikaruudukkoon.

```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"
  }'
```

**Esimerkkivastaus (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": []
}
```

Ota ajanvarauksen `id` talteen. Käytät sitä verinäytteenoton vahvistamiseen.

**4. Vahvista verinäytteenotto**

Kun verinäytteenotto on valmis, lähetä laboratoriokoodi (putken viivakoodi) vahvistaaksesi verinäytteenoton ja käynnistääksesi laboratoriotilausputken. Jos verinäytteenoton putkissa on useita koodeja, lähetä sen sijaan `lab_codes` — katso [Vahvista verinäytteenotto](https://docs.anivahealth.com/fi/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"
  }'
```

**Esimerkkivastaus (200 OK)**

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

Vahvistuksen jälkeen laboratoriotilausputki käynnistyy. Voit hakea ajanvarauksen varmistaaksesi, että sen tila on muuttunut arvoon `"blood_drawn"`.

## Seuraavat vaiheet

* [Lisää paneeleja ajanvaraukseen](https://docs.anivahealth.com/fi/api/appointments/add-panels.md) määrittääksesi, mitkä laboratoriotestit tehdään.
* [Päivitä ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/update-appointment.md) siirtääksesi aikaa tai vaihtaaksesi sijaintia ennen verinäytteenottoa.
* [Peruuta ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/cancel-appointment.md), jos sitä ei enää tarvita.
* [Hae laboratoriotulokset](https://docs.anivahealth.com/fi/api/appointments/get-results.md) noutaaksesi kliiniset ja geneettiset tulokset käsittelyn jälkeen.
* [Lataa asiakirjat](https://docs.anivahealth.com/fi/api/documents/download-document.md) noutaaksesi laboratorioraporttien PDF-tiedostot.
* [Hae profiili](https://docs.anivahealth.com/fi/api/profiles/get-profile.md) tarkistaaksesi tai näyttääksesi potilastiedot.
* Tutustu koko [API-viitteeseen](https://docs.anivahealth.com/fi/api/profiles/create-profile.md) nähdäksesi kaikki saatavilla olevat päätepisteet ja parametrit.


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