Histórico da Página
...
| Produto: |
| ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Segmento: |
| ||||||||||||||||
| Módulo: | Manutenção de Frotas | ||||||||||||||||
| Função: | API do Cadastro de Depósitos | ||||||||||||||||
| País: | Brasil | ||||||||||||||||
| Requisito/Story/Issue (informe o requisito relacionado) : | DAGROMATIV-9044 |
02. SITUAÇÃO/REQUISITO
Sendo Product Owner da solução TOTVS Agro Bioenergia, Posso integrar o cadastro de Depósitos através de uma API exposta para ser consumida do ERP Datasul, Pois isso permitirá que o ERP envie os dados e eles sejam inseridos, editados e excluídos automaticamente no Bioenergia, respeitando as regras de chaves primárias, estrangeiras e de negócios da aplicação.
...
- API Exposta: A API deve estar disponível para ser consumida por qualquer ERP.
- Operações Suportadas: A API deve permitir as operações de inserção, edição e exclusão de registros de Depósito.
- Respeito às Regras de Chaves: Todas as operações devem respeitar as regras de chaves primárias e estrangeiras relacionadas aos registros de Depósito.
- Validação das Regras de Negócios: O processo de integração deve validar as regras de negócios existentes no Bioenergia para garantir a integridade dos dados.
- Confirmação de Sucesso ou Erro: O sistema deve retornar uma confirmação ao ERP após cada operação, indicando sucesso ou erros, com mensagens explicativas.
Estrutura:
...
Atributos
...
Descrição
...
Tamanho
...
Tipo
...
Chave Primária
...
Requerido
...
Valor Default
...
Valores Válidos
...
tipoPonto
...
Flag para indicar o tipo do ponto se abastecimento ou manutenção
...
1
...
STRING
...
N
...
S
...
-
...
A = Abastecimento | M = Manutenção
...
instancia
...
Código da instância relacionada ao ponto de abastecimento/manutenção
...
5
...
STRING
...
N
...
S
...
-
...
-
...
codigo
...
Código do ponto de abastecimento/manutenção
...
5
...
NUMBER
...
S
...
S
...
-
...
-
...
descricaoAbreviada
...
Descrição Abreviada do ponto de abastecimento/manutenção
...
10
...
STRING
...
N
...
S
...
-
...
-
...
descricao
...
Descrição Completa do ponto de abastecimento/manutenção
...
40
...
STRING
...
N
...
S
...
-
...
-
...
movelFixo
...
Flag para indicar se o ponto de abastecimento/manutenção é móvel ou fixo
...
1
...
STRING
...
N
...
S
...
-
...
M = Móvel | F = Fixo
...
captaCusto
...
Apontamentos realizados no ponto de abastecimento/manutenção serão captados pelo CUSTAG
...
1
...
STRING
...
N
...
S
...
-
...
S = Sim | N = Não
...
exportaERP
...
Apontamentos realizados no ponto de abastecimento/manutenção serão exportados para o ERP
...
1
...
STRING
...
N
...
S
...
-
...
S = Sim | N = Não
...
empresaERP
...
Código da empresa no ERP relacionada ao ponto de abastecimento/manutenção
...
15
...
STRING
...
N
...
N
...
-
...
-
...
organizacaoERP
...
Código da organização no ERP relacionada ao ponto de abastecimento/manutenção
...
15
...
STRING
...
N
...
N
...
-
...
-
...
depositoERP
...
Código do depósito no ERP relacionado ao ponto de abastecimento/manutenção
...
15
...
STRING
...
N
...
N
...
-
...
-
...
pontoERP
...
Código do ponto de abastecimento/manutenção no ERP
...
12
...
STRING
...
N
...
N
...
-
...
-
...
pontoCTF
...
Código do ponto de abastecimento no CTF
...
5
...
NUMBER
...
N
...
N
...
-
...
-
...
pontoGTFrota
...
Código do ponto de abastecimento no GTFrota
...
8
...
STRING
...
N
...
N
...
-
...
-
...
tipoRavoTag
...
Forma de identificação RAVO/TAG do ponto de abastecimento no GTFrota
...
1
...
STRING
...
N
...
N
...
-
...
R = RAVO | T = TAG
...
codigoRavoTag
...
Código de identificação RAVO/TAG do ponto de abastecimento no GTFrota
...
19
...
STRING
...
N
...
N
...
-
...
origem
...
Origem do ponto de manutenção
...
1
...
STRING
...
N
...
N
...
-
...
I = Interna | C = Campo | T = Terceiros | E = Concessionária
...
prestadorServico
...
Código do prestador de serviço do ponto de manutenção
...
8
...
NUMBER
...
N
...
N
...
-
URL base:
- entity/v1/pontoAbast
03. SOLUÇÃO
Foi desenvolvida a API conforme estrutura predefinida. API está disponível com os métodos GET, POST, PUT e DELETE.para integração do cadastro de Depósitos.
04. DEMAIS INFORMAÇÕES
- Documentação complementar API https://tdn.totvs.com/x/IxuqNgDepósitos Manutenção Automotiva
05. ASSUNTOS RELACIONADOS
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas