LOX24
Overview
LOX24 API Specification (PT) 2.27
Seção intitulada “LOX24 API Specification (PT) 2.27”Introdução
Nestas páginas você encontrará nossa documentação para transmissão de mensagens usando o Gateway SMS LOX24. A documentação ajuda você a integrar nossa API SMS em suas próprias aplicações e, portanto, a enviar e receber mensagens SMS. Você pode encontrar nossa API SMS em api.lox24.eu. Você acessa as funções individuais de acordo com uma /função. Por exemplo, api.lox24.eu/me para consultar sua conta de cliente e api.lox24.eu/sms para enviar um SMS. Todos os endpoints requerem autenticação por cabeçalho HTTP.
Destaques
- Use HTTPS, para mensagens totalmente criptografadas com SSL
- Envie SMS concatenados, aparecendo como um único SMS no aparelho
- Envie mensagens com texto no conjunto de caracteres GSM 03.38 ou Unicode
- Transmita qualquer ID de remetente com até 15 dígitos ou 11 caracteres
- Envie um SMS em massa para toda a sua lista de contatos com apenas uma solicitação
- Receba respostas às suas mensagens enviadas via HTTP, HTTPS ou SMTP
- Receba ou verifique o status de entrega das mensagens de saída
- Receba mensagens de entrada do seu número de entrada (opcional)
Tipo de Conteúdo da Requisição
O Content-Type para requisições POST e PUT pode ser definido como application/json
ou multipart/form-data (em endpoints com uploads de arquivos).
Cabeçalhos de resposta
Cada resposta da API inclui um identificador de solicitação exclusivo no cabeçalho X-LOX24-REQUEST-ID.
Este identificador alfanumérico de 32 caracteres é gerado para cada solicitação e pode ser usado
para fins de suporte ao relatar problemas ou rastrear chamadas específicas da API.
Propriedades de data e hora
A maioria dos objetos de requisições/respostas de data e hora são timestamps unix (inteiro).
Bloqueio de IP
Se mais de três requisições forem recebidas de um endereço IP com dados de autenticação incorretos dentro de um minuto, todas as requisições subsequentes deste IP receberão uma resposta com o status 429 (Muitas Requisições) dentro dos próximos dez minutos.
Autenticação
Todos os endpoints exigem que você esteja autenticado. Para se autenticar, você precisará criar um token de API a partir da sua conta web (http://account.lox24.eu “Configurações” e “Configurações de API”). Uma vez que você tenha sua Chave de API, você pode passá-la como um cabeçalho HTTP assim:
curl -X GET https://api.lox24.eu/me \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'curl -X POST https://api.lox24.eu/groups/7116/phones \
-H 'Content-Type: application/json' \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
-d '{
"phone": "+4917663804817",
"a": "o2"
}'Método de autenticação legado
Também continuamos a suportar a versão antiga de autenticação com dois cabeçalhos ‘X-LOX24-CLIENT-ID’ e ‘X-LOX24-AUTH-TOKEN’
curl -X GET https://api.lox24.eu/me \
-H 'Host: api.lox24.eu' \
-H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
-H 'X-LOX24-CLIENT-ID: 1234567'Importante!
Nunca compartilhe suas chaves secretas. Mantenha-as protegidas e seguras. Se uma chave for publicada involuntariamente, você pode desativá-la ou excluí-la a qualquer momento em sua conta web (https://account.lox24.eu) nas “Configurações” e “Configurações de API”.
Authentication
Seção intitulada “ Authentication ”After logging in to your web account, you can create, deactivate or delete one or more API keys in the “Settings” under “API Settings” (please select a v2 Key).
Security scheme type: apiKey
Header parameter name: X-LOX24-AUTH-TOKEN