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

# Crear sesión de inserción

> Obtener una URL de un solo uso que muestra los resultados de laboratorio de un perfil dentro de tu app

Obtén una URL que muestra los resultados de laboratorio de un perfil en una página de solo lectura. Abre la URL en un WebView de tu app o en una pestaña del navegador. Llama a este endpoint desde tu servidor cada vez que el usuario abra los resultados y nunca guardes la URL en caché.

Requiere los scopes `embed` y `results_view` en un grupo de perfiles de ese perfil. Aniva concede el scope `embed` previa solicitud. Sin uno de los dos scopes, la solicitud devuelve `403`.

> [!NOTE]
>
> La URL funciona una vez y durante 5 minutos. Al abrirse, la página inicia una sesión de 60 minutos
> que solo mantiene esa página. Archiva tu clave de API para cerrar todas las páginas abiertas a la vez.

## Solicitud

### Parámetros de ruta

**id** `string` *required*

Identificador único (UUID) del perfil cuyos resultados muestra la página.

### Cuerpo

El cuerpo es opcional. Sin cuerpo, la URL abre la lista de biomarcadores en el idioma del perfil.

**language** `string`

Idioma de la página: `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` o `uk`. Por defecto: el idioma del perfil.

**route** `object`

La página que abre la URL. Por defecto: `{ "name": "biomarkers" }`. Cualquier otro `name` devuelve `400`.

**páginas publicadas**

**name** `string` *required*

Uno de:

* `biomarkers`: la lista de todos los biomarcadores con sus últimos resultados.
* `biomarker`: la página de detalle de un biomarcador, con su tendencia, intervalos y explicación. Necesita `biomarker_id`.
* `twin`: el cuerpo en 3D con una puntuación por área de salud. El usuario selecciona un área para ver sus biomarcadores.

**biomarker\_id** `integer`

Solo para `biomarker`. El `biomarker_id` del biomarcador, como en los resultados, por ejemplo `104`. Usa el ID, no el slug: un slug puede cambiar, el ID se mantiene.

**report** `object`

Limita cada página a un informe de laboratorio del perfil. Por defecto: todos los informes del perfil. Envía
exactamente uno de los tres ID. La lista, la tendencia de un biomarcador y el Twin muestran entonces los
resultados solo de ese informe, y la página oculta el filtro de citas. El usuario no puede abrir
otro informe con esta URL.

**propiedades**

**appointment\_id** `string`

El `id` de una cita del perfil. Tu clave debe tener acceso a ella, igual que para
[Obtener resultados de laboratorio](https://docs.anivahealth.com/es/api/appointments/get-results.md). Si no lo tiene, este endpoint devuelve
`404`, no `403`.

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

El `id` de un pedido de kit de prueba en casa del perfil. Tu clave debe tener acceso a él, igual que para
[Obtener resultados de laboratorio](https://docs.anivahealth.com/es/api/home-kit-orders/get-results.md) en pedidos de kit de prueba en casa, y además necesita
`home_kit_orders_view` o `home_kit_orders_manage`.

**document\_id** `string`

El `id` de un informe de laboratorio que hayas subido para el perfil con
[Subir documento](https://docs.anivahealth.com/es/api/documents/upload-document.md). Tu clave debe tener acceso a él, igual que para
[Obtener resultados del documento](https://docs.anivahealth.com/es/api/documents/get-document-results.md). Si no lo tiene, este endpoint
devuelve `404`, no `403`. La página muestra la fecha del análisis de laboratorio, o la fecha de subida cuando
aún no se ha leído ningún valor. Mientras Aniva lee el documento y aún no tiene ningún valor, cada página indica
al usuario que vuelva a abrirla en unos minutos.

**appearance** `object`

El aspecto de la página. La API lo añade a la URL como parámetros de consulta.

**propiedades**

**theme** `string`

`light` o `dark`. Por defecto: el ajuste del sistema del dispositivo.

**primary\_color** `string`

Color hexadecimal de botones y enlaces, de 3 o 6 dígitos, con o sin `#`, por ejemplo `0f766e`.
Por defecto: el color de marca de tu grupo de perfiles o, si no, el naranja de Aniva. Los botones mantienen el texto blanco,
así que elige un color oscuro.

**show\_logo** `boolean`

Muestra el logotipo de tu grupo de perfiles sobre los resultados. Por defecto: `true`.

> [!TIP]
>
> También puedes añadir los parámetros de aspecto tú mismo a una URL devuelta, antes del fragmento `#token=`:
> `theme=light|dark`, `primary=<hex>` y `logo=0`. La página ignora cualquier valor no válido.
> La imagen del logotipo siempre proviene de tu grupo de perfiles, nunca de la URL.

## Respuesta

Si la solicitud tiene éxito, la API devuelve `201 Created`.

**url** `string` *required*

La URL de la página. El token de inicio va en el fragmento `#token=`, así que el navegador nunca lo envía a un
servidor. Ábrela una vez.

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

Instante en formato ISO 8601 a partir del cual no se puede abrir la URL.

La sesión no está vinculada a una sola página. Dentro del embed, el usuario puede pasar del Twin a un biomarcador y moverse entre la lista y las páginas de detalle. La página muestra solo resultados de laboratorio: no muestra valores calculados por Aniva, archivos, chat ni ajustes.

## Respuestas de error

| Estado | Descripción |
| - | - |
| `400` | Error de validación: ID de perfil no válido, `route.name` desconocido, `biomarker_id` no válido, color no válido o un `report` sin exactamente un UUID válido. |
| `403` | Prohibido: a tu clave de API le falta el scope `embed` o `results_view`, o el scope de kit de prueba en casa para un informe de pedido de kit de prueba en casa, o el perfil está fuera de tu contexto de acceso. |
| `404` | Perfil no encontrado, o ningún biomarcador tiene este `biomarker_id`, o el `report` no corresponde a una cita, pedido de kit de prueba en casa ni documento subido de este perfil, o el informe está fuera de tu acceso. Este endpoint devuelve `404`, no `403`, para no revelar que el informe existe. |
| `500` | Error interno del servidor. |

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