Configurações e demais informações a respeito da Integração via API ao Protheus Faturamento

Produto:

Protheus®

Ambiente:

SIGAFAT (Faturamento)

Ocorrência:

Integração ao Protheus Faturamento via requisições de API

Processo:

1. Conceito

Esse mecanismo de consulta via API é utilizado para consultar informações de um processo de um sistema ao outro. Ele ocorre por meio de uma URL com o serviço (Rest ou WS por exemplo), o método (GET por exemplo) e a API, para consultar/alterar as tabelas e dados do outro do sistema a partir de uma Query.

2. APIs

Objetivo: Retorna lista completa de Transportadoras

Estruturação do link:

/api/fat/v1/carrier (não há variáveis na URL)

Estruturação do corpo (Body):

Não há, pois é um GET.

Campos obtigatórios nesse retorno de Status 200:

items.CompanyInternalId
items.InternalId
items.Code
items.Name
items.governamentalInformation.scope
items.governamentalInformation.name

Exemplo:

{
	"hasNext": false,
	"items": [
		{
			"BranchId": "D MG 01 ",
			"CompanyInternalId": "T1D MG 01 000001",
			"InternalId": "D MG 01 000001",
			"Code": "000001",
			"Name": "Transportadora Ex CO",
			"ShortName": "Transportadora Ex",
			"RegisterSituation": "1",
			"governamentalInformation": [
				{}
			],
			"address": [
				{
					"items": [
						{
							"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
							"number": "string",
							"complement": "string",
							"city": {
								"cityCode": "string",
								"cityInternalId": "string",
								"cityDescription": "string"
							},
							"district": "Casa Verde",
							"state": {
								"stateId": "string",
								"stateInternalId": "string",
								"stateDescription": "string"
							},
							"country": {
								"countryCode": "string",
								"countryInternalId": "string",
								"countryDescription": "string"
							},
							"zipCode": "02022010",
							"region": "Zona Norte",
							"poBox": "string",
							"mainAddress": true,
							"shippingAddress": false,
							"billingAddress": true
						}
					]
				}
			],
			"listofComunicationInformation": [
				{
					"Type": "1",
					"PhoneNumber": "string",
					"PhoneExtension": "string",
					"FaxNumber": "string",
					"FaxNumberExtension": "string",
					"HomePage": "string",
					"Email": "string",
					"DiallingCode": "string",
					"InternationalDiallingCode": "string"
				}
			],
			"CarrierType": "1"
		}
	]
}

Campos obrigatórios nesse retorno de Status 400:

code
message
detailedMessage

Exemplo:

{
	"code": "string",
	"message": "string",
	"detailedMessage": "string",
	"helpUrl": "http://example.com",
	"details": [
		{
			"code": "string",
			"message": "string",
			"detailedMessage": "string",
			"helpUrl": "http://example.com"
		}
	]
}

Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos"), onde nesse retorno, é exibido a lista de todas as tranpostadoras e seus detalhes (verificar resultado do retorno 200 na aba acima).

Tabela no Protheus: SA4

Objetivo: Atualiza cadastro de Transportadoras conforme dados enviados na requisição

{{host}}/api/fat/v1/carrier

{{host}}/api/fat/v1/carrier/{InternalId}

3. Arquivos a serem pegos para abertura do ticket

(A) Qual o processo que está sendo realizado? Exemplos: Consulta de impostos no pedido de venda

(B) Qual a URL completa e Método do envio via servidor Rest ou WS?
Contate por favor o sistema origem para tirar essa dúvida, se preciso.
(C) Qual o erro apresentado?

(D) Manualmente o erro ocorre?

Pode lhe Interessar: