Skip to main content
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

1

Armazene sua chave de API

Exporte a chave na sua sessão atual do terminal. Substitua o espaço reservado pela sua chave real.
Não envie chaves de API para o controle de versão. Consulte Autenticação para obter orientações de produção.
2

Consulte seu saldo

Obtenha o saldo da sua conta.

​
Resposta

Uma requisição bem-sucedida retorna HTTP 200 com seu saldo atual.
Se a API retornar 401 ou 403, verifique o nome do cabeçalho e a chave de API. Consulte Tratamento de erros antes de adicionar tentativas de repetição.
Uma resposta de saldo bem-sucedida confirma que sua URL base e a chave de API funcionam juntas.

​
Próximos passos

Enviar uma mensagem do WhatsApp

Envie modelos de mensagem, texto e mensagens de mídia.

Configurar webhooks

Receba atualizações de entrega e mensagens recebidas.

Tratar erros da API

Leia respostas de erro e crie novas tentativas seguras.

Referência da Balance API

Inspecione o esquema de resposta completo e teste o endpoint.