Como fornecer um serviço de SMS via HTTP
Neste guia, você aprenderá como oferecer um serviço de SMS baseado em HTTP usando o Ozeki SMS Gateway. Ao configurar um usuário de API HTTP, gerar chaves de API seguras e configurar o registro adequado, você pode permitir que aplicativos externos enviem mensagens SMS através do seu sistema usando solicitações HTTP. Essa configuração é ideal para desenvolvedores e provedores de serviços que desejam integrar funcionalidades de SMS em seus aplicativos ou oferecer serviços de SMS a clientes. O tutorial também inclui etapas para testar a API com o Postman e monitorar a atividade de mensagens por meio de registros internos para garantir entrega confiável e rastreabilidade.
O que é o Ozeki SMS Gateway?O Ozeki SMS Gateway é uma solução de software poderosa e auto-hospedada projetada para enviar e receber mensagens SMS através de sua própria infraestrutura. Ele suporta protocolos de comunicação padrão, como HTTP, SMPP e outros, tornando-o ideal para integração com aplicativos de negócios. Com o Ozeki SMS Gateway, você pode automatizar notificações por SMS, executar serviços de mensagens bidirecionais e criar sistemas personalizados baseados em SMS para marketing, suporte ao cliente ou alertas de sistema—tudo sem depender de serviços de terceiros.
Criar e configurar um usuário de API HTTP (Passos rápidos)- Abra o Ozeki SMS Gateway e adicione um novo usuário de API HTTP.
- Defina um nome de usuário e senha.
- Gere uma chave de API para acesso seguro.
- Defina a Autorização como Token Bearer usando a chave de API.
- Insira os dados da sua mensagem no formato JSON (destinatário, mensagem, etc.).
- Envie a solicitação e verifique uma resposta de sucesso.
- Ative o registro nas configurações do usuário de API HTTP.
- Ative o registro nos detalhes do serviço de API HTTP.
- Revise os registros de mensagens e HTTP na guia Eventos.
Neste vídeo, você aprenderá como criar um novo usuário de API HTTP no Ozeki SMS Gateway. O tutorial guiará você pelo acesso à interface de gerenciamento de usuários, instalação do componente de usuário de API HTTP e atribuição de um nome de usuário e senha. Uma vez configurado, este usuário poderá enviar e receber mensagens SMS através de solicitações HTTP. Ao final do vídeo, você terá um usuário de API HTTP funcional pronto para integrar com aplicativos externos, facilitando a construção de capacidades de envio de SMS em seus próprios sistemas.
Passo 1 - Abrir o SMS Gateway
Inicie o Ozeki SMS Gateway e navegue até o painel inicial, onde você pode gerenciar usuários, conexões e configurações do sistema (Figura 1).
Clique em "Adicionar novo usuário/aplicativo..." para iniciar o processo de criação de um novo usuário de API HTTP. Isso abrirá uma lista de tipos de usuários disponíveis (Figura 2).
Na lista de Usuários de rede, selecione "Usuário HTTP" e clique em "Instalar" para adicionar este componente ao seu sistema. Este tipo de usuário permite comunicação por SMS via solicitações HTTP (Figura 3).
No painel de configuração, insira um nome de usuário e senha desejados para o usuário de API HTTP. Essas credenciais serão usadas para autenticar solicitações de API (Figura 4).
Após salvar as configurações, o novo usuário de API HTTP está pronto para lidar com operações de SMS via interface de API HTTP (Figura 5).
Neste vídeo, você aprenderá como gerar uma chave de API para um usuário de API HTTP no sistema Ozeki SMS Gateway. A chave de API fornece uma maneira segura de autenticar solicitações sem usar um nome de usuário e senha, simplificando a integração com sistemas externos. O tutorial guiará você pela abertura das configurações do usuário de API HTTP, acesso ao painel de configuração de chave de API e geração de uma nova chave. Ao final do vídeo, você terá uma chave de API válida pronta para uso para envio seguro e eficiente de mensagens SMS via solicitações HTTP.
Passo 6 - Abrir usuário de API HTTP
Navegue até a lista de usuários no Ozeki SMS Gateway e clique no usuário de API HTTP que você criou anteriormente. Isso abrirá o painel de configuração do usuário (Figura 6).
Passo 7 - Configuração da chave de API aberta
No painel de configurações do usuário da API HTTP, localize "Configurar" e clique na opção "Avançado" no menu. Esta seção permite gerenciar chaves de autenticação (Figura 7).
Passo 8 - Gerar nova chave de API
Clique no botão "Gerar nova" para criar uma chave única. Esta chave pode agora ser usada para autenticação por token bearer em requisições de API (Figura 8).
Como testar a API HTTP com a chave de API usando PostMan (Tutorial em vídeo)
Neste vídeo, você aprenderá como testar seu serviço de SMS Ozeki HTTP API usando a ferramenta de teste de API Postman. O tutorial guia você pela autenticação de suas requisições com um token Bearer (chave de API), configuração do corpo da requisição com parâmetros de SMS e envio de uma mensagem de teste. Esta demonstração passo a passo ajuda a verificar se sua configuração de API está funcionando corretamente e mostra como simular o uso real a partir de uma aplicação externa. Ao final, você será capaz de usar o Postman com confiança para testar e solucionar problemas na integração da API de SMS.
Passo 9 - Configurar autorização por token bearer
Abra o Postman, vá para a aba Autorização, defina a URL POST e selecione o tipo de autenticação como "Bearer Token", e cole sua chave de API gerada no campo de token para autenticar a requisição (Figura 9).
Passo 10 - Configurar o corpo da requisição
Mude para a aba Corpo e selecione "raw" como formato. Defina o tipo como JSON e insira seus dados de SMS - como número de telefone do destinatário, ação, tipo de mensagem, dados da mensagem - no formato JSON adequado (Figura 10).
Passo 11 - Enviar requisição de mensagem
Clique no botão "Enviar" no Postman. Se configurado corretamente, você receberá uma resposta de sucesso do servidor, confirmando que a mensagem foi aceita para entrega (Figura 11).
Como visualizar os logs do usuário da API HTTP (Tutorial em vídeo)
Neste vídeo, você aprenderá como visualizar logs detalhados para um usuário da API HTTP no Ozeki SMS Gateway. Monitorar logs é essencial para solucionar problemas e verificar a entrega de mensagens SMS enviadas pela API. O tutorial mostra como acessar as configurações do usuário da API HTTP, ativar o registro de logs se não estiver ativo e revisar os logs gerados durante o envio de mensagens. Ao final do vídeo, você saberá como rastrear a atividade de mensagens, identificar problemas e garantir a confiabilidade de suas comunicações por SMS.
Passo 12 - Abrir usuário da API HTTP
Na interface do Ozeki SMS Gateway, navegue até a seção "Usuários e Aplicações" e abra o usuário da API HTTP cujos logs você deseja inspecionar (Figura 12).
Passo 13 - Ativar registro de logs
Vá para a aba Configurar na configuração http_api details. Ative todas as três opções marcando a caixa de seleção em Nível de Log. Clique em "Ok" (Figura 13).
Passo 14 - Log de envio de mensagem
Uma vez que o registro de logs estiver ativo, envie uma mensagem de teste e vá para a seção Eventos. Aqui você encontrará informações detalhadas sobre a requisição da mensagem, incluindo horários, destinatário, conteúdo da mensagem e resposta da API (Figura 14).
Como visualizar os logs do servidor da API HTTP (Tutorial em vídeo)
Neste vídeo, você aprenderá como acessar e revisar logs em nível de servidor para o serviço de API HTTP no Ozeki SMS Gateway. Esses logs fornecem uma visão abrangente de todos os eventos de requisição e resposta HTTP tratados pelo servidor, o que é essencial para depuração em nível de sistema, monitoramento de tráfego e garantia da confiabilidade do serviço. O tutorial demonstra como abrir as configurações do serviço de API HTTP, ativar o registro de logs e verificar tanto os logs relacionados a mensagens quanto os logs brutos de transações HTTP. Ao final, você estará equipado para monitorar a atividade da API em todo o sistema com clareza e precisão.
Passo 15 - Abrir detalhes do serviço HTTP API
No Ozeki SMS Gateway, vá para a seção "Avançado" e localize o serviço HTTP API. Clique em "Detalhes" para abrir o painel de configuração detalhado (Figura 15).
Passo 16 - Ativar registro de logs
Navegue até a aba "Registro de Logs" nas configurações do serviço HTTP API. Ative o registro de logs marcando as opções. Clique em "Ok" para aplicar as alterações (Figura 16).
Passo 17 - Log de eventos de mensagem
Após ativar o registro de logs, vá para a aba "Eventos" para visualizar o log de eventos de mensagem. Esta seção mostra todas as transações relacionadas a SMS processadas pelo HTTP API, incluindo códigos de status e resultados de entrega (Figura 17).
Passo 18 - Log de eventos HTTP
Mude para a aba de log Eventos HTTP para ver detalhes de requisições e respostas HTTP em nível baixo. Isso inclui cabeçalhos, endpoints acessados e payloads - útil para solução avançada de problemas e depuração de integrações (Figura 18).
Conclusão
Este guia demonstrou detalhadamente como estabelecer um serviço robusto de SMS via HTTP usando o Ozeki SMS Gateway. Seguindo os passos detalhados, você pode criar e configurar com sucesso um usuário de API HTTP, gerar chaves de API seguras, e integrar funcionalidades de SMS em aplicações externas. A capacidade de enviar mensagens SMS via requisições HTTP abre um leque de possibilidades para desenvolvedores e provedores de serviços que desejam automatizar notificações, construir soluções personalizadas de mensagens ou oferecer capacidades de SMS aos seus clientes.
Além disso, a ênfase em ativar e monitorar logs garante a entrega confiável de mensagens e fornece insights cruciais para solução de problemas e manutenção da integridade do serviço. Com o Ozeki SMS Gateway, você obtém uma plataforma poderosa e flexível para todas as suas necessidades de comunicação via SMS baseada em HTTP, permitindo mensagens SMS eficientes, seguras e de fácil integração.
Comece a construir seu Serviço de SMS HTTP. Primeiro, vá até a página de download e baixe o software Ozeki SMS Gateway se você ainda não o fez. Em seguida, siga os passos acima e envie sua primeira mensagem SMS. Se tiver alguma dúvida, registre-se em myozeki.com e pergunte à nossa equipe técnica.
More information