> For the complete documentation index, see [llms.txt](https://docs.supria.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.supria.com/devs/api-de-consulta/primeiros-passos.md).

# Primeiros passos

Esta página mostra o caminho mais rápido para começar a usar a API de consulta do Supria Workspaces: como conseguir sua chave de API e como fazer sua primeira chamada autenticada.

### Antes de começar

Para usar a API de consulta, você precisa ter acesso de administrador no Supria Workspaces. É lá que você vai encontrar a URL da API e gerar sua chave de acesso, em Configurações > Chave de API.

<figure><img src="https://3079342455-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBzupU7EJYFILEsnEc3yO%2Fuploads%2FP376PnGzmDFiUDSuRdSp%2Fimg1-supria.png?alt=media&amp;token=cfe73521-8fc8-488e-acfa-465e574f4541" alt="Tela Configurações do Supria Workspaces com a opção Chave de API."><figcaption><p>Gere sua chave de API em <strong>Configurações > Chave de API</strong>.</p></figcaption></figure>

{% hint style="warning" %}
Mantenha sua chave de API em **sigilo**. Ela funciona como uma credencial de acesso aos dados do seu workspace e não deve ser compartilhada ou publicada em relatórios, arquivos ou código-fonte.
{% endhint %}

### Autentique suas chamadas

A API usa autenticação HTTP Basic. Em vez de usuário e senha, você usa a palavra ApiKey como usuário e sua chave de API como senha.

* Usuário: ApiKey
* Senha: sua chave de API

A URL base da API é:

```
https://api.supriaworkspaces.com/_api/
```

O cabeçalho de autenticação da chamada fica assim:

```
Authorization: Basic ApiKey {sua_chave_de_api}
```

### Faça sua primeira chamada

Com a chave em mãos, você já pode testar a API. O exemplo abaixo usa curl para listar os workspaces disponíveis:

```
curl -u "ApiKey:{sua_chave_de_api}" https://api.supriaworkspaces.com/_api/Workspaces
```