> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API

## Endpoint base

O endpoint base para todas as chamadas da API é `/api` no domínio `appsignal.com`.

```shell Shell theme={null}
https://appsignal.com/api
```

## Respostas

O tipo de resposta suportado pela API do AppSignal é JSON. Em alguns endpoints
JSONP também é suportado.

Garanta que todas as requisições para endpoints terminem com a extensão `.json` para que nenhuma URL
precise ser atualizada no futuro.

## Autenticação

| Parâmetro | Tipo                |                 Descrição |
| --------- | ------------------- | ------------------------: |
| token     | string, obrigatório | Sua chave de API pessoal. |

Todas as requisições aos endpoints da API do AppSignal exigem um `token` de API pessoal informado
como parâmetro de consulta na URL para autenticação.

```shell Shell theme={null}
https://appsignal.com/api/[endpoint].json?token=personal_api_key
```

(Substitua `[endpoint]` pelo endpoint que você precisa.)

Sua chave de API pessoal pode ser encontrada na [tela de configurações
pessoais](https://appsignal.com/users/edit).

## Aplicações

| Parâmetro | Tipo                |       Descrição |
| --------- | ------------------- | --------------: |
| app\_id   | string, obrigatório | ID da aplicação |

Todos os endpoints fornecidos pela nossa API têm escopo a nível de aplicação, não a nível de
organização (mais de uma aplicação).

Para que a API saiba quais dados retornar de qual aplicação, o ID da aplicação
precisa ser informado na URL do endpoint.

Por exemplo, dada esta string na documentação da API:

```shell Shell theme={null}
/api/[app_id]/samples.json
```

A URL se torna:

```shell Shell theme={null}
https://appsignal.com/api/5114f7e38c5ce90000000011/samples.json?token=abc
```

O `app_id` de uma aplicação pode ser encontrado na URL do
[AppSignal.com](https://appsignal.com/accounts) quando uma aplicação é aberta.
Por razões legadas, a URL mencionará `/sites` em vez de `/applications`.
O id que segue é o id da sua aplicação.

```shell Shell theme={null}
https://appsignal.com/demo-organization/sites/5114f7e38c5ce90000000011
```