Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • transactions: utilizado para receber mensagens que devem ser gerenciadas pelo Engine de EAI. As mensagens recebidas neste predicado devem ter, obrigatoriamente, um identificador único (UUID) e podem ser encaminhadas para uma fila, quando o modo de operação for assíncrono. É o equivalente à operação receiveMessage do padrão SOAP/XML.
  • contents: utilizado para receber mensagens onde apenas o conteúdo é relevante, e não há necessidade de maiores controles, como rastreamento de mensagens por UUID e gerenciamento de fila assíncrona. Por isso, neste endpoint, o modo de operação será exclusivamente síncrono.
Nota

Uma integração com produto Totvs não será possível ser realizada através do endpoint /Transactions e /Contents ao mesmo tempo. Terá que ser habilitado uma das duas opções.

Informações

Salvo quando explicitamente indicado no documento, deve-se considerar que os endpoints disponibilizam os recursos previstos no Guia de Implementação de APIs para paginação, ordenação e filtro de dados.

...

  • transactionID_version: identificador que designa a transação e versão a ser considerada;
  • internalID: identificador da instância da entidade indicada pela transação e versão informados no parâmetro anterior. Por exemplo: quando a transação e versão for "customervendor_1_000", o parâmetro internalID deve conter um valor que identifique um registro de cliente/fornecedor no originador da requisição.

    Consequentemente, no recebedor da requisição, será necessário uma estrutura de tradução - de-para - que permita identificar o registro equivalente no destino.

    Esse valor deve ser a PK do registro no ERP, adquirido na chamada GET.


Os métodos Os métodos previstos são:


  • GET: para recuperar entidades.
  • POST: para incluir entidades ou efetuar requisições.
  • PUT: para alterar entidades.
  • DELETE: para eliminar entidades, nesta opção deve retornar apenas o HTTPStatus.

Informações
titleSobre o InternalID

O InternalID não deve ser enviado no método POST.

Não há DE-PARA endpoint /contents

Nota

Como não haverá header, a filial deve ser informada no content. Caso não existir essa informação, se assumirá como sendo compartilhado.

Informações
titleSobre o formato de mensagens
O formato de mensagem utilizado nas requisições para o endpoint /contents é mais simples, já que não requer as informações de cabeçalho utilizadas para realizar o controle da mensagem (rastreamento, fila, etc). A proposta é apenas utilizar-se do modelo de mensagem padronizada para trafegar informações entre as partes. Na prática, o modelo de dados que será trafegado nas requisições corresponde apenas ao atributo content do modelo completo, usado pelo endpoint /transactions.

...

Exemplos de utilização deste predicado podem ser vistos nos link a seguir:

...