Envio de SMS com falha de configuração de body com JSON mal formado

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, porém uma falha de configuração de body com JSON mal formato acontece.

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 o comportamento de falha de body com JSON mal formato.

Descrição

No ambiente de execução deste cenário, ocorrem alguns erros de envios de SMS para alguns provedores devido à falhas de configuração de body com JSON mal formato.

No entanto esses SMS que são dados como falhas genéricas de envio, estão sem o tratamento correto do problema por não existir a configuração de retornos para os casos de body com JSON mal formato.

Requisição

Essa seção apresenta na tabela abaixo as definições relacionadas à requisição HTTP para o envio do SMS usando uma API externa.

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: 154567" }

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

Essa seção apresenta as configurações das respostas HTTP esperadas tanto de sucesso como a resposta de falha de body com JSON mal formado.

No caso de um JSON mal formado, não importa muito o que está incorreto no formato pois será detectado como JSON inválido. O código HTTP de retorno será um 400 Bad Request.

Para mais detalhes sobre o formato JSON consultar a documentação da RFC 8259.

Resposta de envio da API de SMS

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

Resposta de falha de body com JSON mal formado

A tabela abaixo descreve as informações de retorno da API de envio quando ocorre uma falha de body com JSON mal formado e portanto um 400 Bad Request.

Item	Descrição
HTTP STATUS	400 Bad Request
Body	{ "status": "REQUISIÇÃO INVÁLIDA" }
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]}"

Observe que na configuração acima está faltando fechar o objeto JSON do body da requisição.

Configuração dos Retornos

A configuração dos retornos, feito na aba Retornos, deve evidenciar quando o retorno é um 200 OK com sucesso no envio. Além disso deve evidenciar as falhas de envios por erros de body com JSON mal formado.

Dado o cenário e o fato de que os retornos são avaliados na ordem, sugere-se a seguinte configuração dos Retornos:

Retorno	Descrição
Retorno de falha de body com JSON mal formado	retorno quando o código HTTP é 400. Será considerado como FALHA de requisição inválida.
Retorno da API de SMS	retorno quando o código HTTP é 200 e não cai no retorno anterior. Será considerado como SUCESSO.
Retorno padrão	retorno diferente do que está definido nos retornos anteriores. Será considerado como FALHA.

Analisando os retornos acima, observa-se que qualquer retorno 400 que voltar pro Blazon, será definido como FALHA de requisição inválida.

Caso o retorno seja 200 OK vai casar com a definição do retorno de envio da API e será definido como SUCESSO.

Qualquer coisa diferente disso vai cair no retorno padrão que será considerado como FALHA.

As configurações dos retornos descritos, na tabela acima, estão detalhadas abaixo:

Retorno de falha de body com JSON mal formado

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

Campo	Valor
Tipo	Código HTTP
Valor	400
Status	Falha
Situação	Falha de requisição inválida com JSON mal formado

Observa-se que a configuração verifica apenas o código de retorno, se ele é 400 será detectado como FALHA de requisição inválida com JSON mal formado.

Retorno da API de SMS

Como esse retorno tem que validar apenas o código HTTP 200 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	Sucesso no envio

Observa-se que a configuração verifica apenas o código de retorno, se ele é 200 será detectado como 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 nos retornos anteriores será dado como FALHA.