TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Integrações - Filiais - EM HOMOLOGAÇÃO

Versões comparadas

Versão antiga 6

changes.mady.by.user Helen Crystina Godinho Amorim

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Rodrigo da Silva Ribeiro

Gravado em

Chave

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

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração com filiais.

Pré-Requisitos e Restrições

  • Necessário instalar o serviço winthor-filial na rotina 801 do WTA, conforme indicação Parametrizações WTA.

Integração


Totvs custom tabs box
tabsDados integrados com Winthor, Envio Parâmetros, Resposta da Requisição, Principais dúvidas e conflitos
idspasso1,passo2,passo3,passo4

A integração consiste em retornar todas as filiais cadastradas na rotina 535

Totvs custom tabs box items
defaultyes
referenciapasso1

Os dados integrados são: 

Table Filter
inversefalse
ddSeparator
sparkNameSparkline
columnSECTIONS | PCFILIAL API
hidePaneTable header
isNewfalse
separatorPoint (.)
labelsSECTIONS | PCFILIAL API
default
ddOperator
cell-width150
datepatternyy-mm-dd
id1698435687462
isORAND
formatVersion2
order0


SECTIONS                            |         PCFILIAL


API

Referência Winthor

Referência da imagem abaixo 

id

PCFILIAL.CODIGO

1

corporateName

PCFILIAL.RAZAOSOCIAL

4

aliasName

PCFILIAL.FANTASIA

5

corporateIdentificationNumber

PCFILIAL.CGC

2

stateRegistration

PCFILIAL.IE

3

municipalRegistration

PCFILIAL.IM

--

address

PCFILIAL.ENDERECO

7

addressNumber

PCFILIAL.NUMERO

9

addressComplement

PCFILIAL.COMPLEMENTOENDERECO

12

district

PCFILIAL.BAIRRO

8

city

PCFILIAL.CIDADE

--

state

PCESTADO.ESTADO

13

federativeUnit

PCESTADO.UF

10

codStateIbge

PCESTADO.CODIBGE


codCityIbge

PCFILIAL.CODMUN

12

zipCode

PCFILIAL.CEP

11

phoneNumber

PCFILIAL.TELEFONE

6

exclusion

PCFILIAL.DTEXCLUSAO

--

optingSimplesNacionalPCFILIAL.
OPTANTESIMPLESNACIONAL
OPTANTESIMPLESNAC--
createdAtPCFILIAL.DTCADASTRO--
lastChangePCFILIAL.DTULTALTER--


Image Added


Totvs custom tabs box items
defaultno
referenciapasso2

Exemplo do envio da requisição:

Bloco de código
languagejs
titleURI
method: 'GET',
url: '/api/branch/v1/'
Bloco de código
languagejs
titleParams
id			: 1						- código da filial
page		: 1						- número da página
pageSize	: 10					- quantidade por página
lastChange  :                        AAAA-MM-DDTHH:MM:SS   - data de ultima alteração



Totvs custom tabs box items
defaultno
referenciapasso3

Exemplo JSON da resposta:  

Bloco de código
languagejs
titleResponse
{


    "first": false,


    "items": [


        {


            "id": "1",


            "corporateName": "Totvs Tecnologia
em Software de Gestao LTDA 
",


            "aliasName": "TOTVS
GOIÂNIA
",


            "corporateIdentificationNumber": "00000000000000",


            "stateRegistration": "
106953273
0000000",


            "address": "RUA
135
 xpto",


            "addressNumber": 0,


            "district": "
MARISTA
",


            "city": "
GOIANIA
",


            "state": "
GOIAS
",


            "federativeUnit": "
GO
",


            "codStateIbge":
52
 ,


            "codCityIbge":
5208707
 ,


            "zipCode": "
74180020
",


            "phoneNumber": "
0623250020
",


            "createdAt": "2022-04-25T09:12:04",


            "lastChange": "2022-04-25T09:12:04"


        }


    ],


    "hasNext": false


}
Totvs custom tabs box items
defaultno
referenciapasso4
Expandir
titleApresentou Status Code 404 Not Found ao enviar a requisição
? 

Caso obtenha o conteúdo abaixo ao enviar a requisição, verifique na rotina 812 do WTA se o serviço winthor-

filiais

filial está instalado. Caso não esteja, acesse a rotina 801 do WTA e realize a instalação conforme indicação na documentação APIs Integrações - Filiais  

Bloco de código
languagejava
<html>
 
<head>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <title>Error 404 Not Found</title>
</head>
 
<body>
    <h2>HTTP ERROR 404</h2>
    <p>Problem accessing /api/branch/v1/. Reason:
        <pre>    Not Found</pre>
    </p>
    <hr><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.3.21.v20170918</a>
    <hr />
 
</body>
 
</html>
Expandir
titleInstalei o serviço e apresentou Status Code 403 Forbidden ao enviar a requisição

Caso apresente 403 Forbidden, verifique se realizou a autenticação antes do envio da requisição.

Bloco de código
languagejava
{
    "mensagem": "O Usuário não está autorizado a utilizar esse recurso",
    "erros": []
}