Especificação Técnica

Introdução

A API do sistema Plannix é responsável por comunicar-se com a base de dados

do sistema e a interface do usuário.

A API disponibiliza para integração com outros sistemas e/ou funcionalidades

alguns métodos que permitem a leitura na base de dados.

Estrutura

A API é totalmente desenvolvida em C# .net, cada método possui seus

parâmetros específicos para filtro dos dados. O retorno dos dados dos serviços será
em JSON.

Rev.02 - 24/03/2023
Token

Para utilização de todos os serviços é necessário um token obtido pelo serviço

abaixo utilizando um usuário e senha que pode ser criado pelo app Desktop.

Endereço Post:

https:// LINKDAEMPRESA/NOMESERVICO/api/Autenticacao

Body recebe um JSON nesse formato:

"nome": "usuario",

"senha": "senha"

Retorno:
{

"userInfo": {

"Status": 200,

"CodUsuario": 1,

"PermissaoTempo": true,

"PermissaoMobile": 1,

"CodInspetor": 1,

"ProcessosAtivos": "F2, F5, F1, F3, F4,",

"Token": "nwBLzBWAUtWy6f751UsNLw==",

"PermissaoObra": 1,

"TemIntegracao": false,

"NomeUsuario": "USUÁRIO SUPERVISOR",

"TelasPermitidas": [

"Registro de Fabricação",

"Registro Qualidade Fabricação",

 "Registro Montagem",

"Registro Carga",

"Registro Acabamento",

"Estoque Peça",

"Registro Qualidade Acabamento",

"Pós Produção",

"Programação de Fabricação",

"Inventário",

"Programação de Montagem",

"Corte e dobra",

"Armação",

"Forma",

"Forma c/ Armação",

"Concretagem",

"Amarração de família de corpo de prova",

"Corte e dobra - QUALIDADE",

"Armação - QUALIDADE",

"Forma - QUALIDADE",

"Forma c/ Armação - QUALIDADE",

"Concretagem - QUALIDADE",

"Liberação de entrada",

"Carregando",

"Liberação de Saída"

}
1 – Produção das peças a matéria prima utilizada no processo.

Método responsável por retornar uma lista de peças produzidas em um

intervalo e as matérias primas consumidas.

Endereço GET:
https://LINKDAEMPRESA/NOMESERVICO/api/bi/producao?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy

Obs: A parte do link onde LINKDAEMPRESA e NOMESERVICO deverá ser solicitado a Plannix

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
FaseProducao String Fase da produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Equipe String Equipe que executou a fase de produção
Forma String Forma da peça
Peso Decimal Peso da peça
Traco String Traço da peça
Volume Decimal Volume da peça
Componentes SET Matéria Prima utilizada
Código ERP String Código do material no ERP
Descricao String Descrição do material
Quantidade Decimal Quantidade utilizada
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP
2 – Produção das peças a matéria prima utilizada no processo SEM CONSUMO.

Método responsável por retornar uma lista de peças produzidas em um

intervalo.

Endereço GET:
https://
LINKDAEMPRESA/NOMESERVICO/api/bi/producaosemconsumo?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
FaseProducao String Fase da produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Equipe String Equipe que executou a fase de produção
Forma String Forma da peça
Peso Decimal Peso da peça
Traco String Traço da peça
Volume Decimal Volume da peça
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP
3 – Peças programadas

Método responsável por retornar uma lista de peças programadas a serem

produzidas, em um intervalo de tempo.

Endereço GET:
https:// LINKDAEMPRESA/NOMESERVICO /api/bi/programacaofabrica?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Forma String Forma da peça
Peso Decimal Peso da peça
Volume Decimal Volume da peça
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP
4 – Estoque de Peças - Peças projetadas ainda não produzidas

Método responsável por retornar uma lista das peças projetadas e ainda não
produzidas, em um intervalo de tempo.

Endereço GET:
https:// LINKDAEMPRESA/NOMESERVICO /api/bi/estoqueprojeto?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Forma String Forma da peça
Peso Decimal Peso da peça
Volume Decimal Volume da peça
Equipe String Equipe que projetou a peça
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP
5 – Cargas Expedidas

Método retorna uma lista das cargas expedidas com suas respectivas peças
contidas na mesma.

Endereço GET:
https:// LINKDAEMPRESA/NOMESERVICO /api/bi/cargasexpedidas?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime “yyyy-MM-dd”
dataFinal DateTime “yyyy-MM-dd”

Retorno:

Nome Campo Tipo de dado Observação

NumeroCarga Int Número da carga
NomeObra String Nome da obra
Motorista String Nome do Motorista
Transportadora String Transportadora da carga
SiglaObra String Sigla da Obra
Pecas SET
CodigoControle String Código da Peça Plannix
PesoPeca Decimal Peso da peça
NomePeca String Nome de peça
6 – Lista de Obras

Método retorna uma lista das obras cadastradas no sistema.

Endereço GET:
https:// LINKDAEMPRESA/NOMESERVICO /api/bi/obras?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy&sigla=SiglaObra

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime “yyyy-MM-dd”
dataFinal DateTime “yyyy-MM-dd”
Sigla String “Sigla”

Retorno:

Nome Campo Tipo de dado Observação

codObra Int Código da obra
NomeObra String Nome da obra
codAuxiliarObra String Codigo adicional da obra no ERP
Tipo String Tipo da obra
SiglaObra String Sigla da Obra
dataInicial DateTime Data inicial da obra
dataFinal DateTime Data final da obra
cor String RGB da cor da obra
Status String Status da obra
CNPJ String Cnpj da obra
inscEstadual String Inscrição estadual da obra
7 – Peças Projetadas.

Método responsável por retornar uma lista de peças projetadas em um

intervalo ou por sigla da obra.

Endereço GET:
https://LINKDAEMPRESA/NOMESERVICO/api/bi/pecasProjetadas?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy&sigla=SiglaObra

Obs: A parte do link onde LINKDAEMPRESA e NOMESERVICO deverá ser solicitado a Plannix

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy
Sigla String “Sigla”

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
FaseProducao String Fase da produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Equipe String Equipe que executou a fase de produção
Peso Decimal Peso da peça
Classe String Traço da peça
Volume Decimal Volume da peça
Código ERP String Código do material no ERP
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP
8 – Peças Montadas.

Método responsável por retornar uma lista de peças montadas em um

intervalo ou por sigla da obra.

Endereço GET:
https://LINKDAEMPRESA/NOMESERVICO/api/bi/pecasMontadas?dataInicial=dd/MM/yyyy&dataFinal=
dd/MM/yyyy&sigla=SiglaObra

Obs: A parte do link onde LINKDAEMPRESA e NOMESERVICO deverá ser solicitado a Plannix

Parâmetros:

Nome Campo Tipo de Dado Observação

dataInicial DateTime dd/MM/yyyy
dataFinal DateTime dd/MM/yyyy
Sigla String “Sigla”

Retorno:

Nome Campo Tipo de dado Observação

NomePeca String Nome da peça
NomeObra String Nome da obra
SiglaObra String Sigla da obra
Data Datetime Data de produção
FaseProducao String Fase da produção
Produto String Produto
Grupo String Grupo do Produto
Seção String Seção do produto
Unidade String Fábrica que produziu a peça
CodigoControle String Código único da Plannix
Comprimento Decimal Comprimento da Peça
Equipe String Equipe que executou a fase de produção
Peso Decimal Peso da peça
numeroCarga int Numero da carga.
Volume Decimal Volume da peça
Código ERP String Código do material no ERP
codAuxiliarObra String Codigo adicional da obra no ERP
codAuxiliarProduto String Codigo auxiliar produto no ERP
codAuxiliarGrupo String Codigo auxiliar de grupo no ERP