# Comece agora com a API da Instatus

Source: https://instatus.com/help/pt-br/api

Todos os endpoints ficam sob a URL `https://api.instatus.com`. Em geral, eles seguem a arquitetura REST.

Todas as requisições precisam ser codificadas em JSON com o cabeçalho `Content-Type: application/json`.

As respostas da API da Instatus, inclusive os erros, também são codificadas em JSON.

## Autenticação

As requisições para a API da Instatus precisam informar um token de API no cabeçalho Authorization:

Você encontra sua chave de API em Configurações do usuário → [Configurações de desenvolvedor](https://dashboard.instatus.com/developer)

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

## Obtenha o ID da sua página
Você encontra o ID da sua página no painel seguindo estes passos:
1. Acesse seu painel.
2. Clique com o botão direito no seu projeto, no canto superior esquerdo, para abrir o menu.
3. Clique em **Copy Project ID** e o ID da página é copiado para a área de transferência.

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

## Erros

Todos os endpoints da API trazem um código e uma mensagem dentro das respostas de erro.

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

## Valores de status

Status possíveis da página. Este é o `status` detalhado retornado pela API atual (v2 em diante). O endpoint legado `summary.json` e as [notificações por webhook](https://instatus.com/help/pt-br/webhooks) usam uma forma condensada, com apenas `UP`, `HASISSUES` e `UNDERMAINTENANCE`.

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

Status possíveis do componente:

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

Status possíveis do incidente:

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

Status possíveis da manutenção:

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

## Ir para os endpoints:

- [Páginas de status](https://instatus.com/help/pt-br/api/status-pages)
- [Workspaces](https://instatus.com/help/pt-br/api/workspaces)
- [Componentes](https://instatus.com/help/pt-br/api/components)
- [Incidentes](https://instatus.com/help/pt-br/api/incidents)
- [Atualizações de incidentes](https://instatus.com/help/pt-br/api/incident-updates)
- [Manutenções](https://instatus.com/help/pt-br/api/maintenances)
- [Atualizações de manutenção](https://instatus.com/help/pt-br/api/maintenance-updates)
- [Modelos](https://instatus.com/help/pt-br/api/templates)
- [Avisos gerais](https://instatus.com/help/pt-br/api/generic-notices)
- [Quedas](https://instatus.com/help/pt-br/api/outages)
- [Membros do time](https://instatus.com/help/pt-br/api/teammates)
- [Assinantes](https://instatus.com/help/pt-br/api/subscribers)
- [Métricas](https://instatus.com/help/pt-br/api/metrics)
- [Perfil do usuário](https://instatus.com/help/pt-br/api/user-profile)
- [Dados públicos](https://instatus.com/help/pt-br/api/public-data)
- [Páginas privadas](https://instatus.com/help/pt-br/api/private-pages)
- [Grupos de público](https://instatus.com/help/pt-br/api/audience-groups)
- [Monitores](https://instatus.com/help/pt-br/api/monitors)
- [Integrações de monitoramento](https://instatus.com/help/pt-br/api/monitoring-integrations)
- [Regras de roteamento](https://instatus.com/help/pt-br/api/routing-rules)
- [Políticas de escalonamento](https://instatus.com/help/pt-br/api/escalation-policies)
- [Escalas de plantão](https://instatus.com/help/pt-br/api/on-call-schedules)