TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • Integração Força de Vendas - API

Versões comparadas

Versão antiga 41

changes.mady.by.user Helen Crystina Godinho Amorim

Gravado em

comparado com

Nova versão 42

changes.mady.by.user Helen Crystina Godinho Amorim

Gravado em

Chave

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

...

Expandir
titleIniciando

Nossas APIs são baseadas no protocolo HTTP E possui URLs previsíveis, é orientada a recursos e utiliza códigos de resposta HTTP para indicar sucesso ou erros e exceções.

As respostas (incluindo os erros) e o corpo das requisições são obrigatoriamente formatados em JSON.

Sobre as requisições à API

Os seguintes verbos HTTP estão disponíveis para uso:

VerboDescrição
GETSolicita dados de um recurso
POST

Cria um novo recurso

PUT

Atualiza um recurso

DELETEExclui um recurso


Cabeçalho das requisições

O cabeçalho de requisição HTTP usado é:

Accept: application/json

Content-Type: application/json

** Deve-se especificá-los no header das requisições à API.


Autenticação/Autorização

Utilizamos o Apache Shiro para identificar se a solicitação de acesso a API está autenticada, portanto apenas passar No Auth no Type Auth.


Erros & Respostas

Utilizamos os códigos de resposta HTTP convencionais para indicar sucesso ou falha em uma solicitação à API.

  • Respostas de informação (100-199),
  • Respostas de sucesso (200-299),
  • Redirecionamentos (300-399)
  • Erros do cliente (400-499)
  • Erros do servidor (500-599).


URI Parameters

Alguns recursos disponibilizados podem oferecer a possibilidade de utilização de “URI Parameters” amigáveis.
Os parâmetros quando disponíveis são:

• filter - Habilita filtragem (consulta) de resultados.

Expandir
titleLista de APIs disponíveis
Expandir
titleLogin

Realiza o login do usuário passando os dados usuário e senha no body da requisição.

URI  :   /winthor/autenticacao/v1/login

Customer
Expandir
titleCadastro de Cliente

Ao performar a requisição será preenchida a tabela temporária PCLIENTFV, assim que finalizar a importação, poderá ser visualizado através da rotina 302 - Cadastrar Cliente.

URI  :   /api/wholesale/v1/salesForce/customer


Expandir
titlePOST/PUT


Expandir
title
DEL


Expandir
titlecustomerReference

Importar referencia de cliente (PCCLIEREFFV) juntamente com seu cadastro principal da tabela (PCCLIENTFV), para isso basta relacionar as principais chaves CPF/CNPJ.

IMPORTADO 
1 - Inserido os dados na tabela 
2 - Referencia de cliente importado com sucesso
3 - Cliente não cadastrado ou excluído


Expandir
titlePOST/PUT
PCCLIREFFV
Chaves Obrigatórias : CGCCLI, CODREF
Objetivo: Armazenas as referências de clientes na tabela PCCLIREFFV.

"imported": 1,- PCCLIREFFV.IMPORTADOFlag de importação do pedido
"personIdentificationNumber": {{cpf}},- PCCLIREFFV.CGCCLIcgc/Cpf do cliente
"referenceCode": 1,- PCCLIREFFV.CODREFsequencial para referencia por cliente
"customerCode": 1,- PCCLIREFFV.CODCLICodigo do cliente
"referenceName": "{{$randomCompanyName}}",- PCCLIREFFV.EMPREFERnome da referencia
"referencePhone": "{{$randomPhoneNumber}}",- PCCLIREFFV.TELREFERTelefone da referencia
"referenceContact": "{{$randomLastName}}",- PCCLIREFFV.CONTATOREFERContato da referencia
"creditLimit": "{{$randomPrice}}",- PCCLIREFFV.LIMCREDREFERLimite de credito
"dateRegisterReference": "10/12/2020 14:10:08",- PCCLIREFFV.DTCADASTROREFERData de cadastro da referencia
"dateLastPurchase": "10/12/2020 14:10:08",- PCCLIREFFV.DTULTCOMPREFERData da ultima compra
"valueLastPurchase": "{{$randomPrice}}",- PCCLIREFFV.VLULTCOMPREFERValor da ultima compra
"observation": "testetestetetestetestetestetestetestetesttet",- PCCLIREFFV.OBSObservação
"biggestPurchaseDate": "10/12/2020 14:10:08",- PCCLIREFFV.DTMAIORCOMPREFERData da maior compra
"biggestPurchaseValue": "{{$randomInt}}",- PCCLIREFFV.VLMAIORCOMPREFERValor da maior compra
"referenceChargeCode": "{{$randomInt}}"- PCCLIREFFV.CODCOBREFERCodigo de cobrança
Grava automaticamente- PCCLIREFFV.OBSERVACAO_PCMensagem de retorno da package
Grava automaticamente- PCCLIREFFV.DTINCLUSAOData de inclusão do registro na tabela
Expandir
titleDEL




Expandir
titlegondola
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titlegondolaItem
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titleindemnity
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titleitemIndemnityOrder
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titlecutsMadeOrders
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titlemessage
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titlegiftOrderItem
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titlevisit
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titleheaderOrder
Expandir
titlePOST/PUT


Expandir
titleDEL


Expandir
titleorderDetailSaleForce
Expandir
titlePOST/PUT


Expandir
titleDEL