Envio de SMS com sucesso

Nesse caso de uso o envio do SMS é feito e espera-se para cada requisição HTTP um retorno 200 OK como sucesso do envio.

Público alvo deste caso de uso

Analista de IAM, ou qualquer outro profissional que será responsável pela administração do Blazon.

Objetivo

Esse cenário tem como objetivo descrever como realizar as configurações adequadas do provedor de SMS de forma a capturar um envio com sucesso baseado no retorno HTTP 200 OK.

Descrição

No ambiente de execução deste cenário, os envios de SMS são realizados por uma API externa a qual retorna um 200 OK sempre que o envio resulta em sucesso.

Requisição

As definições relacionadas à requisição HTTP de envio são:

Item	Valor
Método HTTP	POST
URL	https://sms.services/api/send-sms.php
Segurança	Autenticação HTTP básica:
Cabeçalhos	Accept: application/json Content-Type: application/json
Body	{ "telefone": "34---------", "mensagem": "Token de autenticação Blazon: 203040" }

Com as configurações acima a API envia um SMS para o telefone descrito no JSON do body, contendo a mensagem definida juntamente com o token de acesso.

Resposta

A tabela abaixo descreve as informações de retorno da API de SMS quando o envio ocorre com sucesso.

Item	Descrição
HTTP STATUS	200 OK
Body	{ "status": "SUCESSO" }
Response-type	application/json

Configurações

As configurações descritas nessa seção são referenciadas na documentação do Administrador na página Configurando um provedor de SMS.

Configurações da Requisição

Todas as configurações são realizadas no detalhamento do provedor na aba Configurações:

• O método HTTP e URL são definidos no topo do card da aba de Configurações;

• A configuração de Segurança é feita na aba Segurança selecionando o tipo "Autenticação HTTP Básica";

• A configuração dos cabeçalhos é feita na aba Cabeçalhos, adicionando-se os dois cabeçalhos descritos;

• A configuração do Body é feita na aba Body, configurando o media-type application/json e com o conteúdo:

  • {
      "telefone": "${[to]}",
      "mensagem": "Token de autenticação Blazon: ${[token]}"
    }

Configuração dos Retornos

A configuração dos retornos, feito na aba Retornos, deve evidenciar quando o retorno da API é um 200 OK como sucesso no envio. Qualquer coisa diferente disso será considerado como falha no envio.

Dado o cenário sugere-se a seguinte configuração dos Retornos:

Retorno	Descrição
Retorno da API de SMS	retorno do tipo código HTTP que resulta SUCESSO quando o código é 200.
Retorno padrão	resulta FALHA

A configuração dos retornos descritos na tabela estão detalhados abaixo:

Retorno da API de SMS

Como esse retorno tem que validar apenas o código HTTP sugere-se a configuração usando o tipo Código HTTP que é mais simples e direta.

Campo	Valor
Tipo	Código HTTP
Valor	200
Status	Sucesso
Situação	OK

Na configuração desse retorno, basta que seja verificado que o código HTTP de retorno seja igual a 200 o que configura um SUCESSO no envio.

Nota

A configuração do retorno padrão é intuitiva e basta definir o status como Falha e definir a situação como Falha no envio do SMS.

Nesse caso qualquer coisa que retornar diferente do que foi configurado no retorno anterior será dado como FALHA.