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 e, em seguida, envie-a no cabeçalho de solicitação X-API-Key.
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.
Explorar o endpoint
Abra Enviar um 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.
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 para obter o formato de resposta e orientações de repetição.
