A API ConectorGate permite a utilização de dois métodos para personalização dos campos da API padrão:

• Cadastramento de campos de usuário específicos no Setup da API (campos reservados)
• Cadastramento de campos de usuário na tabela CUSTOM

Personalização via Setup da API

A API ConectorGate prevê alguns campos de usuário padrão que podem ser definidos no Setup da API. São eles:

CAMPO DE USUÁRIO	Campo na API	Global Property (SAPB1 – SAP B1If)	Parâmetro (PROTHEUS – SX6)
ID externo do pedido	customOrderKey	UdfOrderKey	IG_UDFSOKY
Status do pedido	customOrderStatus	UdfOrderStatus	IG_UDFSOST
Status Notificado do pedido	customOrderStatusNotify	UdfOrderStatusNotify	IG_UDFSOSN
Tipo de Transporte do pedido	customShippingType	UdfShippingType	IG_UDFSHTY
Método de Transporte do pedido	customShippingMethod	UdfShippingMethod	IG_UDFSHMT
Tracking Key do pedido	customTrackingKey	UdfTrackingKey	IG_UDFTKKY
Tracking Url do pedido	customTrackingUrl	UdfTrackingUrl	IG_UDFTKUR
Chave de acesso da NFe	customNfeAccessKey	UdfNfeAccessKey	IG_UDFNFAK
Codigo de autorização da NFe	customNfeAuthCode	UdfNfeAuthCode	IG_UDFNFAC
Protocolo de autorização da NFe	customNfeProtocol	UdfNfeProtocol	IG_UDFNFPT

Personalização via Tabela CUSTOM

Para a utilização de campos customizados (campos de usuário), ou de campos padrão não previstos na API, a API prevê a criação e utilização de uma (1) tabela auxiliar no banco de dados do ERP.

Tabela de campos Custom = [@IGT_CUSTOM]

Nesta tabela devem ser cadastrados os campos customizados no ERP, ou campos padrão do ERP não previstos na API, e sua relação com campos obtidos no request/response ou valores fixos.

Nesta tabela temos 2 campos importantes:

• IPO: indica se o campo será utilizado no Inbound (PUT/POST) ou no Outbound (GET). Opções: I=inbound, P=processing, O=outbound
• DATATYPE: indica a origem/destino do valor do campo no processamento, se algum campo do request/response (API field), se terá valor fixo, ou ainda se terá a data ou a hora ou a origem do acesso à API. Opções: A=API field, F=Fixed value, D=date, T=time, S=source

Os campos que forem cadastrados na tabela Custom da API, para incrementar os requests ou responses de sua API, podem ser consultados no Portal de Monitoramento. Acesse a seção de usuário > My Custom.

Os registros podem ser incluídos na tabela CUSTOM: [1] pelo banco de dados (INSERT INTO), [2] pelo Postman (usando a API ConectorGate).