Histórico da Página

...

No contexto do componente Atividade de serviço, os headers (cabeçalhos) geralmente representam informações adicionais ou metadados que são enviadas enviados junto com a requisição de um serviço. Eles são usados para fornecer contexto ou parâmetros extras que o serviço ou a operação que está sendo chamada pode precisar para processar a requisição.

Esses headers podem ser usados para várias finalidades, dependendo do tipo de serviço e da operação. Alguns exemplos típicos comuns de headers são:

• Autenticação e autorização: pode ser um token de autenticação, uma chave de API ou credenciais de um usuário.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Authorization Valor: Bearer token_de_acesso

• Informações de rastreio: dados sobre a requisição que podem ser usados para monitoramento ou rastreamento da chamada do serviço.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: X-Request-ID Valor: 12345

• Informações de contexto: dados que definem o contexto da requisição, tais como o idioma, a localidade ou a versão da API.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Accept-Language Valor: pt-BR

• Formato dos dados: definição sobre como os dados devem ser interpretados ou enviados, como o tipo de conteúdo (Content-Type) ou a versão da API.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Content-Type Valor: application/json

Os headers são frequentemente usados em chamadas de APIs REST ou SOAP e permitem adicionar informações cruciais para a comunicação entre sistemas. Cada chave/valor tem um propósito específico e a definição correta desses headers pode ser fundamental para o sucesso da integração com o serviço. Eles são importantes porque permitem personalizar ou configurar as requisições e, muitas vezes, podem ser obrigatórios para que o serviço funcione corretamente., podem ser obrigatórios para que o serviço funcione corretamente.

Parâmetros

Âncora
parametros parametros

...

No contexto do componente Atividade de serviço, os parâmetros são valores ou variáveis que o método/operação precisa receber para funcionar corretamente. Cada método/operação de um serviço geralmente tem uma lista de parâmetros que precisam ser fornecidos para que a execução da ação seja bem sucedida. Sendo assim, o objetivo de configurar esses parâmetros é fornecer as informações necessárias para que o método/operação execute a ação corretamente.

Esses parâmetros podem ser de diversos tipos, como números, textos, datas ou até mesmo objetos, que são uma estrutura de dados mais complexa.

Além de fornecer os dados essenciais para a execução do método/operação, outros objetivos da configuração dos parâmetros podem envolver:

• a definição do contexto da execução: os parâmetros podem determinar o contexto no qual a operação será executada.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Um parâmetro de "idioma" pode ser usado para alterar o idioma de uma resposta ou para personalizar a resposta do serviço com base na localização do usuário.

• a comunicação eficiente entre sistemas: quando diferentes sistemas estão interagindo, é essencial que os parâmetros estejam corretamente configurados para que a comunicação e o entendimento entre eles ocorra corretamente.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Se um serviço externo precisa de um código de produto para retornar informações sobre ele, esse código precisa ser passado corretamente como um parâmetro.

• a execução condicional ou dinâmica: a execução de uma operação pode depender de um parâmetro específico que vem de outra parte do processo.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Um valor de "status" pode ser usado para decidir se a operação deve continuar ou se uma outra operação deve ser executada, o que permite a execução dinâmica e condicional do processo.

• o mapeamento de dados: 

Por exemplo, ao chamar um método/operação para processar um pagamento, o serviço pode precisar do número do cartão de crédito, do valor e dos dados do comprador. Esses são os dados que devem ser passados como parâmetros.

Retorno

Âncora
retorno retorno

...

No contexto do componente Atividade de serviço, o retorno são 

Parâmetro de Saída: Em alguns casos, a operação pode retornar dados como resultado, e você pode mapear esses parâmetros de saída para usá-los em outra parte do processo.

• Exemplo:

  • ID do Usuário: 12345 (valor retornado pela operação)

Configurar componente Atividade de serviço – Rest

...

...

05. Em Header, clique em Adicionar header para adicionar parâmetros informações adicionais à requisição do serviço.

...

06. Insira os dados necessários para cada parâmetro header.

 Estado
subtle
true
title
Exemplo

Chave: Content-Type
Valor: application/json

07. Xxxxxxxxxxxxxxx Clique na aba Parâmetros para configurar os parâmetros da operação que serão enviados na requisição do serviço.

08. Xxxxxxxxxxxxxxx

...

...