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

# Início rápido

> Autentique-se com a YCloud e faça sua primeira requisição de API.

Neste guia de início rápido, você chama a Balance API para confirmar que a URL base e a chave de API estão configuradas corretamente.

## Antes de começar

Você precisa de:

* Uma conta da YCloud
* Uma chave de API da YCloud
* `curl` ou outro cliente HTTP

## Como funciona

Toda requisição de API do lado do servidor usa a URL base `https://api.ycloud.com/v2` e envia sua chave no cabeçalho `X-API-Key`. Este exemplo obtém o saldo da conta porque não cria nem envia nada.

## Requisição

<Steps>
  <Step title="Armazene sua chave de API">
    Exporte a chave na sua sessão atual do terminal. Substitua o espaço reservado pela sua chave real.

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    export YCLOUD_API_KEY="YOUR_API_KEY"
    ```

    Não envie chaves de API para o controle de versão. Consulte [Autenticação](/pt/api-reference/guides/api-fundamentals/authentication) para obter orientações de produção.
  </Step>

  <Step title="Consulte seu saldo">
    Obtenha o saldo da sua conta.

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    curl https://api.ycloud.com/v2/balance \
      --header "X-API-Key: $YCLOUD_API_KEY" \
      --header "Accept: application/json"
    ```
  </Step>
</Steps>

## Resposta

Uma requisição bem-sucedida retorna HTTP `200` com seu saldo atual.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "amount": 10.5,
  "currency": "USD"
}
```

| Campo | Descrição |
| - | - |
| `amount` | Saldo disponível da conta. |
| `currency` | Moeda ISO usada pela conta. |

Se a API retornar `401` ou `403`, verifique o nome do cabeçalho e a chave de API. Consulte [Tratamento de erros](/pt/api-reference/guides/api-fundamentals/handle-errors) antes de adicionar tentativas de repetição.

<Tip>Uma resposta de saldo bem-sucedida confirma que sua URL base e a chave de API funcionam juntas.</Tip>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Enviar uma mensagem do WhatsApp" icon="whatsapp" href="/pt/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Envie modelos de mensagem, texto e mensagens de mídia.
  </Card>

  <Card title="Configurar webhooks" icon="webhook" href="/pt/api-reference/guides/api-fundamentals/configure-webhooks">
    Receba atualizações de entrega e mensagens recebidas.
  </Card>

  <Card title="Tratar erros da API" icon="triangle-exclamation" href="/pt/api-reference/guides/api-fundamentals/handle-errors">
    Leia respostas de erro e crie novas tentativas seguras.
  </Card>

  <Card title="Referência da Balance API" icon="code" href="/api-reference/balance/retrieve-balance">
    Inspecione o esquema de resposta completo e teste o endpoint.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.