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 no Parametrizações WTA.
Integração
Totvs custom tabs box |
---|
tabs | Dados integrados com Winthor, Envio Parâmetros, Resposta da Requisição, Passo 04Principais dúvidas e conflitos |
---|
ids | passo1,passo2,passo3,passo4 |
---|
|
A integração consiste em retornar todas as filiais cadastradas na rotina 535 Totvs custom tabs box items |
---|
default | yes |
---|
referencia | passo1 |
---|
| Os dados integrados são: Table Filter |
---|
inverse | false |
---|
ddSeparator | |
---|
sparkName | Sparkline |
---|
hidePane | Table header |
---|
column | SECTIONS | PCFILIAL API |
---|
isNew | false |
---|
separator | Point (.) |
---|
labels | SECTIONS | PCFILIAL API |
---|
default | |
---|
ddOperator | |
---|
cell-width | 150 |
---|
datepattern | yy-mm-dd |
---|
id | 1698435687462 |
---|
isOR | AND |
---|
formatVersion | 2 |
---|
order | 0 |
---|
| SECTIONS | PCFILIAL |
---|
API | Referência Winthor |
---|
id | PCFILIAL.CODIGO | corporateName | PCFILIAL.RAZAOSOCIAL | aliasName | PCFILIAL.FANTASIA | corporateIdentificationNumber | PCFILIAL.CGC | stateRegistration | PCFILIAL.IE | municipalRegistration | PCFILIAL.IM | address | PCFILIAL.ENDERECO | addressNumber | PCFILIAL.NUMERO | addressComplement | PCFILIAL.COMPLEMENTOENDERECO | district | PCFILIAL.BAIRRO | city | PCFILIAL.CIDADE | state | PCESTADO.ESTADO | federativeUnit | PCESTADO.UF | codStateIbge | PCESTADO.CODIBGE | codCityIbge | PCFILIAL.CODMUN | zipCode | PCFILIAL.CEP | phoneNumber | PCFILIAL.TELEFONE | exclusion | PCFILIAL.DTEXCLUSAO | optingSimplesNacional | PCFILIAL. |
| OPTANTESIMPLESNACIONALOPTANTESIMPLESNAC | createdAt | PCFILIAL.DTCADASTRO | lastChange | PCFILIAL.DTULTALTER |
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| Exemplo do envio da requisição: Bloco de código |
---|
| method: 'GET',
url: '/api/branch/v1/' |
Bloco de código |
---|
| 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 |
---|
default | no |
---|
referencia | passo3 |
---|
| Exemplo JSON da resposta:
"corporateName": "Totvs Tecnologia | em Software de Gestao LTDA GOIÂNIA
"corporateIdentificationNumber": "00000000000000", |
106953273 135
MARISTA GOIANIA GOIAS GO 52 5208707 74180020 0623250020
"createdAt": "2022-04-25T09:12:04", |
"lastChange": "2022-04-25T09:12:04" |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo4 |
---|
| Expandir |
---|
title | Apresentou 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-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 |
---|
| <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 |
---|
title | Instalei 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 |
---|
| {
"mensagem": "O Usuário não está autorizado a utilizar esse recurso",
"erros": []
} |
|
|
|