> ## 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. # API da YCloud > Crie fluxos de trabalho de mensagens, verificação, contatos e eventos com as APIs da YCloud. A YCloud oferece uma única API para comunicação com clientes e fluxos de engajamento. Você pode enviar mensagens de WhatsApp, SMS, e-mail e voz. Também pode verificar usuários, gerenciar contatos, rastrear eventos personalizados e receber atualizações de status por meio de webhooks. ## Como funcionam as requisições Todas as requisições do lado do servidor utilizam esta URL base: ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} https://api.ycloud.com/v2 ``` Autentique as requisições com uma chave de API no cabeçalho `X-API-Key`. Mantenha a chave no seu servidor e nunca a exponha no código do navegador ou do aplicativo móvel. ```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" ``` Configure sua chave de API e faça sua primeira requisição autenticada. Armazene e use sua chave de API da YCloud com segurança. Receba atualizações de status de mensagens e mensagens recebidas. Siga guias práticos para fluxos de integração comuns. ## O que você pode criar Envie modelos, textos, mídias, mensagens interativas e muito mais. Envie mensagens SMS globais e códigos de voz automatizados. Envie e-mails em HTML ou texto simples a partir de um domínio ativado. Gerencie WABAs, números de telefone, modelos, Flows, mídias e chamadas. Gerencie contatos, eventos personalizados e cancelamentos de assinatura por canal (opt-outs). ## Requisição Envie corpos de requisição JSON com `Content-Type: application/json`. Os parâmetros de caminho (path) e de consulta (query) estão documentados na página de cada endpoint. ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}} curl --request POST https://api.ycloud.com/v2/sms \ --header "X-API-Key: $YCLOUD_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "to": "+16315551234", "text": "Your order has shipped." }' ``` Use a Referência da API quando precisar do schema completo da requisição, dos valores de enum ou de um construtor de requisições interativo. ## Resposta As respostas bem-sucedidas usam JSON. Uma resposta de criação ou envio confirma que a YCloud aceitou a requisição. Ela nem sempre confirma a entrega final ou a conclusão. Armazene o ID do recurso retornado e correlacione-o com resultados de consulta ou eventos de Webhook. Os erros incluem um `code` legível por máquina, um `message` voltado para desenvolvedores e um `requestId` que você pode fornecer ao suporte da YCloud. Alguns produtos exigem a ativação da conta, um remetente aprovado ou uma conta do WhatsApp Business conectada antes que você possa enviar mensagens. ## Do guia à referência da API Entenda as janelas de mensagens, os modos de envio, os campos de requisição e os status de entrega. Inspecione o schema completo de requisição e resposta de envio direto. Saiba como funcionam as requisições de SMS e as atualizações de entrega. Inspecione o schema completo de requisição e resposta de SMS. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.