# Primeros pasos con la API de Instatus

Source: https://instatus.com/help/es/api

Todos los endpoints están bajo la URL `https://api.instatus.com`. En general siguen la arquitectura REST.

Todas las peticiones deben codificarse en JSON con la cabecera `Content-Type: application/json`.

Las respuestas de la API de Instatus, incluidos los errores, también están codificadas en JSON.

## Autenticación

Las peticiones a la API de Instatus deben incluir un token de API en la cabecera Authorization:

Puedes obtener tu clave de API en Ajustes de usuario → [Ajustes de desarrollo](https://dashboard.instatus.com/developer)

```bash
Authorization: Bearer <API_KEY>
```

## Obtén el ID de tu página
Puedes encontrar el ID de tu página en el panel siguiendo estos pasos:
1. Ve a tu panel.
2. Haz clic derecho en tu proyecto, arriba a la izquierda, para abrir el menú.
3. Haz clic en **Copiar ID del proyecto** y el ID de tu página se copiará al portapapeles.

![ID de la página](https://instatus.com/help/page_id.png)

## Errores

Todos los endpoints de la API devuelven un código y un mensaje dentro de las respuestas de error.

```json
{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}
```

## Valores de estado

Estados posibles de la página. Este es el `status` detallado que devuelve la API actual (v2 y posteriores). El endpoint antiguo `summary.json` y las [notificaciones por webhook](https://instatus.com/help/es/webhooks) usan una forma reducida con solo `UP`, `HASISSUES` y `UNDERMAINTENANCE`.

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

Estados posibles de un componente:

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

Estados posibles de una incidencia:

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

Estados posibles de un mantenimiento:

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## Ir a los endpoints:

- [Páginas de estado](https://instatus.com/help/es/api/status-pages)
- [Equipos](https://instatus.com/help/es/api/workspaces)
- [Componentes](https://instatus.com/help/es/api/components)
- [Incidencias](https://instatus.com/help/es/api/incidents)
- [Actualizaciones de incidencias](https://instatus.com/help/es/api/incident-updates)
- [Mantenimientos](https://instatus.com/help/es/api/maintenances)
- [Actualizaciones de mantenimiento](https://instatus.com/help/es/api/maintenance-updates)
- [Plantillas](https://instatus.com/help/es/api/templates)
- [Avisos generales](https://instatus.com/help/es/api/generic-notices)
- [Interrupciones](https://instatus.com/help/es/api/outages)
- [Miembros del equipo](https://instatus.com/help/es/api/teammates)
- [Suscriptores](https://instatus.com/help/es/api/subscribers)
- [Métricas](https://instatus.com/help/es/api/metrics)
- [Perfil de usuario](https://instatus.com/help/es/api/user-profile)
- [Datos públicos](https://instatus.com/help/es/api/public-data)
- [Páginas privadas](https://instatus.com/help/es/api/private-pages)
- [Grupos de audiencia](https://instatus.com/help/es/api/audience-groups)
- [Monitores](https://instatus.com/help/es/api/monitors)
- [Integraciones de monitoreo](https://instatus.com/help/es/api/monitoring-integrations)
- [Reglas de enrutamiento](https://instatus.com/help/es/api/routing-rules)
- [Políticas de escalado](https://instatus.com/help/es/api/escalation-policies)
- [Calendarios de guardias](https://instatus.com/help/es/api/on-call-schedules)