SaveStep é uma operação da API do Beew4y. Está operação tem como finalidade realizar a comunicação externa com os componentes do tipo "Eventos Intermediários", para que ele possam continuar sua execução e o fluxo de processo seguir.
Está operação utiliza o protocolo de comunicação HTTPS com serialização dos objetos em formato JSON e seu EndPoint é "{{urlServer}}/api/process/SaveStep".
Em {{urlServer}} deve ser informado o domínio de sua plataforma Beew4y.
Utilizamos o padrão JWT para autenticação das operações, portando no header da requisição deve ser informado o parâmetro "Authorization" com o valor "Bearer <token>", sendo que o token deve ser de um usuário que possui permissão para processos. Por exemplo:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjNTMzMjFjOS00MDJiLTQ3NDItOTg3MC0xNmRiZmUasdySWQiOiIxNzAiLCJUeXBlIjoiMCIsIk1vZGUiOiIwIiwiVXNlcm5hbWUiOiJasdamVubyIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMvcm9sZSI6IkFkbWluaXN0cmF0b3IifQ.tRewWO6XI_BNhEt3x501R8K8ZwBI3vaU8BCQ2vDMtdEi
Utilizamos para esse parâmetro o padrão Bearer Authentication. Saiba mais.
Saiba mais sobre as permissões de usuário clicando aqui.
No body da requisição deve ser enviado os seguintes parâmetro:
{
"executionGuid": "3162bcc2-c9c8-40ba-8c80-1e41472e7d9e",
"token": "35519294-18b0-49b8-aaa3-aab795d9eeb0",
"jsonData": "{\"exemplo\": \"objeto result\"}"
}
Está propriedade é obrigatória e nela deve ser informado o identificador da execução(instância) chamado "GUID".
Está propriedade é obrigatória e nela deve ser informado o identificador do passo que está aguardando a ação externa. Esse identificador se chama "BPAStepToken" e é adicionado como uma propriedade do objeto BO (Business Object) durante a execução do passo.
Saiba mais sobre o BO (Business Object) clicando aqui.
Está propriedade é opcional, caso enviada seu valor deve ser um JSON, esse JSON será convertido nas propriedades do objeto Result, que poderá ser utilizado nos eventos do passo e também nos próximos passos do fluxo.
Saiba mais sobre o objeto Result clicando aqui.
Os possíveis retornos são:
Requisição realizada com sucesso e o fluxo irá continuar sua execução.
Requisição inválida, nesse caso o fluxo irá permanecer da mesma forma e será retornada uma string com o motivo do erro.
Requisição não autorizada, nesse caso o fluxo irá permanecer da mesma forma e é provável que o token utilizado no parâmetro "Authorization" não seja válido.