> ## 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.

# Interface de API

> Autentique-se com uma chave de API e envie mensagens SMS por meio da API da YCloud.

## Obter uma chave de API

A YCloud autentica solicitações no lado do servidor com chaves de API. Crie ou visualize uma chave de API em [**Dashboard > Desenvolvedores > Chaves de API**](https://www.ycloud.com/console/#/app/developers/apikey) e, em seguida, envie-a no cabeçalho de solicitação `X-API-Key`.

<Warning>
  Mantenha as chaves de API no seu servidor. Nunca as envie para um repositório nem as exponha no código do navegador ou do aplicativo móvel.
</Warning>

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST 'https://api.ycloud.com/v2/sms' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "to": "+16315551234",
    "text": "Your verification code is 123456."
  }'
```

Se preferir um SDK, consulte os idiomas disponíveis e as instruções de instalação em [Desenvolvedores da YCloud](https://github.com/ycloud-developers).

## Explorar o endpoint

Abra [Enviar um SMS](/api-reference/sms/send-an-sms) para ver os parâmetros completos da solicitação, o esquema de resposta e o construtor interativo de solicitações. Para obter o fluxo de trabalho de integração de ponta a ponta e considerações sobre a entrega, consulte [Enviar um SMS](/pt/api-reference/guides/messaging/send-sms).

## Processar a resposta

Uma resposta `2xx` indica que a YCloud aceitou a solicitação. Isso não significa necessariamente que o SMS foi entregue ao destinatário. Armazene o ID da mensagem retornado e correlacione-o com os resultados de recuperação ou eventos de webhook para acompanhar a entrega.

## Tratar erros

As respostas de erro incluem três campos:

* `code` é o identificador de erro estável e legível por máquina.
* `message` explica o erro para os desenvolvedores.
* `requestId` ajuda o suporte da YCloud a solucionar problemas em uma solicitação.

Use o identificador de erro estável na lógica do seu aplicativo. Não faça a correspondência com a explicação voltada para desenvolvedores. Consulte [Tratar erros](/pt/api-reference/guides/api-fundamentals/handle-errors) para obter o formato de resposta e orientações de repetição.


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