Páginas filhas
  • 1 - Integração API Builder

Versões comparadas

Chave

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

Procedimentos necessários para iniciar a integração API Builder

No banco de dados terá que criar views de consulta no APIBuilder e todas possuam Os campos em vermelho são os campos obrigatórios na integração, além destes é necessário que todas as VIEW possuam estes dois campos: data de última atualização do registro (LastUpdateAt), para que o Connector busque somente os registros que sofreram atualização desde a última consulta para a integração e não ter que buscar todos os registros todas as vezes (Dia, Mês, Ano, Hora, Minuto, Segundo e Milissegundos), e campo de contagem de registros (countItens), onde deverá retornar à quantidade de itens encontrados na consulta.

Para cada Entidade relacionada terá que seguir a documentação e relação de campos do Swagger do CRM.

Link da Documentação Swagger APIS do CRM.

https://master-crm-api.totvs.app/swagger/index.html


Relação de VIEWs que devem ser criadas no ApiBuilder

Entidade (View)Criar Rota no API Bulder  Rota na Documentação Swagger CRM
Empresa-Filial       company

CompanyBulk

Moeda                currency

Currency

Unidade de Medida    unitofmeasure

MeasurementUnit

Usuário              userUser
Região               region

RegionUserBulk

Transportadora       carrierCarrier
Grupo de Produtos    productgroupProductGroup
Produto              productProductBulk
Tipo de Frete        freightstype

Freight

Condição de Pagamentopaymentcondition

PaymentConditionEAI

Tabela de Preço      pricetable

PriceTableBulk

Itens Tabela de Preçopricetableitens

PriceTableItemBulk

Cliente      customer

CustomerBulk

Estoquestock

StockBulk


Exemplo de API GET consumindo uma VIEW criada no TOTVS API Builder.


Image Added

Exemplo de Consulta gerada através dessa api e json gerado conforme a documentação Swagger CRM.

Image Added