Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 9

changes.mady.by.user Vinicius Domingues da Silva Fonseca

Gravado em

comparado com

Nova versão 10

changes.mady.by.user Vinicius Domingues da Silva Fonseca

Gravado em

Chave

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

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


Expandir
titleCarrier (Transportadora)
Deck of Cards
idMétodos
Card
idGETCARRIER
labelGET (Consulta/visualização)
Expandir
title{{host}}/api/fat/v1/carrier

Objetivo: Retorna lista completa de Transportadoras

Deck of Cards
idStatus
Card
id(1) Estruturação
label(1) Estruturação

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.
Card
id(2) Retornos e resultados
label(2) Retornos e resultados
Expandir
title200 (SUCESSO)

Campos obtigatórios nesse retorno de Status 200:


Exemplo:

Bloco de código
{
	"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"
		}
	]
}
Expandir
title400 (ERRO NA REQUISIÇÃO)

Campos obtigatórios nesse retorno de Status 400:

  • code
  • message

  • detailedMessage


Exemplo:

Bloco de código
{
	"code": "string",
	"message": "string",
	"detailedMessage": "string",
	"helpUrl": "http://example.com",
	"details": [
		{
			"code": "string",
			"message": "string",
			"detailedMessage": "string",
			"helpUrl": "http://example.com"
		}
	]
}
Card
id(3) Conclusão
label(3) Conclusão

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.





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

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

Card
idPOSTCARRIER
labelPOST (Inclusão)

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

Card
idPUTCARRIER
labelPUT (Alteração)

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

Card
idDELETECARRIER
labelDELETE (Exclusão)

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



Expandir
titlecustomerVendor (Cliente)




Expandir
titlecustomerCreditLimit (Limite de crédito do cliente)



Expandir
titlepaymentCondition (Condição de Pagamento)




Expandir
titlesalesCharge (Comissão)




Expandir
titlePriceListHeaderItems (Tabela de Preços)




Expandir
titleseller (Vendedor)




Expandir
titlesalesTaxes (Impostos no pedido de venda)







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?

    Expandir
    titleComo buscar a URL da integração API e o método?

    Contate por favor o sistema origem para tirar essa dúvida, se precisso.



  • (C) Qual o erro apresentado?


  • (D) Manualmente, o erro ocorre?


Pode lhe Interessar: