Webservicesqmb: Difference between revisions

From QuatenusWiki
← Older edit
VisualWikitext
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{QuatenusHeader}}
{{Página de Documentação Técnica}}


= Web Services Quatenus® Core – Licenciamento =
== Web Services Quatenus® Core ==
O '''Quatenus Core''' é uma plataforma de localização inteligente mundial (WWIL) que disponibiliza uma série de Web Services para a obtenção de dados de licenciamento, gestão de ativos e frotas[cite: 185, 186, 189].


== 📌 Introdução ==
=== Endereços e Autenticação (Servidores de Produção) ===
 
Os serviços estão organizados por categorias e podem ser acedidos através dos seguintes endpoints WSDL (Infraestrutura Brasil)[cite: 213, 223]:
Este documento descreve os Web Services do Quatenus® Core para obtenção de dados de licenciamento.
 
Versão: 12.00
Data: Outubro 2025
Fonte:
 
== 🌐 Endereços e Autenticação ==
 
=== QDats ===
 
Licenciamento (Gamas)
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl
</code>
Ativos
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl
</code>
Viaturas
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl
</code>
 
=== QBMDats ===
 
Items / Extras
<code>.../QBMDats/Business/QbmItems/QbmItemsServices.svc?wsdl</code>
Entidades
<code>.../QBMDats/Administration/Entities/Entity.svc?wsdl</code>
Documentos
<code>.../QBMDats/Documents/Document.svc?wsdl</code>
Payment Terms
<code>.../QbmDats/Business/PaymentTerms/PaymentTermsServices.svc?wsdl</code>
 
=== 🔐 Autenticação ===
 
Parâmetros comuns:


{| class="wikitable"
{| class="wikitable"
! Serviço !! Categoria !! URL de Produção (WSDL)
|-
| QDats || Licenciamento e Gamas || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl [cite: 215]
|-
| QDats || Ativos (Assets) || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl [cite: 217]
|-
| QDats || Viaturas e Combustíveis || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl [cite: 221]
|-
| QBMDats || Itens e Serviços || http://services.quatenus-system.com.br/quatenus10/QBMDats/Business/QbmItems/QbmltemsServices.svc?wsdl [cite: 231]
|-
| QBMDats || Entidades (Clientes/Parceiros) || http://services.quatenus-system.com.br/quatenus10/QBMDats/Administration/Entities/Entity.svc?wsdl [cite: 236]
|-
| QBMDats || Documentos (Contratos/Propostas) || http://services.quatenus-system.com.br/quatenus10/QBMDats/Documents/Document.svc?wsdl [cite: 242]
|}


! Parâmetro !! Descrição
==== Dados para Testes ====
companyId
Para chamadas de teste, devem ser utilizados os seguintes argumentos de autenticação[cite: 249]:
-
* '''userName:''' agoraqbmadmin@testesst.pt [cite: 249]
deviceIds
* '''password:''' Ipiranga2013 [cite: 249]
-
userName
-
password
-
token
}
 
== 🧪 Serviços Disponíveis ==
 
=== 📦 Gamas ===
 
<code>SrvGovernmentGet.GetPartnerCodesFamilies()</code>
 
=== 📱 Dispositivos ===
 
<code>ISrvGtiAssetGet.GetAssetBrands()</code>
<code>ISrvGtiAssetGet.GetAssetModels()</code>
 
=== 🚗 Viaturas ===
 
<code>ISrvGtiFleetGet.GetVehiclesBrands()</code>
<code>ISrvGtiFleetGet.GetVehiclesModels()</code>
<code>ISrvGtiFleetGet.GetVehiclesClassType()</code>
<code>ISrvGtiFleetGet.GetFuelTypes()</code>
 
=== 📦 Items ===
 
<code>QbmItemsServices.GetLicensableItems()</code>
<code>QbmItemsServices.GetLicensableItemExtras()</code>
<code>QbmItemsServices.GetDeviceClasses()</code>
 
=== 👤 Entidades ===
 
<code>IEntity.GetCustomers()</code>
<code>IEntity.GetPartners()</code>
 
=== 📄 Documentos ===
 
<code>IDocument.GetExternalContracts()</code>
<code>IDocument.GetExternalBillingEvents()</code>
 
=== 💰 Pagamentos ===
 
<code>IPaymentTermsServices.GetPaymentTermsExternal()</code>
 
== 🔎 Estrutura Geral dos Serviços ==


A maioria dos serviços segue o mesmo padrão:
=== Principais Métodos Disponíveis ===
Abaixo estão listados alguns dos métodos fundamentais para integração[cite: 256]:


=== Argumentos Comuns ===
==== Gamas e Dispositivos ====
* '''SrvGovernmentGet.GetPartnerCodesFamilies():''' Obtém a lista de gamas de produtos[cite: 258, 282].
* '''ISrvGtiAssetGet.GetAssetBrands():''' Obtém a lista de marcas de dispositivos[cite: 262, 326].
* '''ISrvGtiAssetGet.GetAssetModels():''' Lista de modelos de dispositivos[cite: 338].


{| class="wikitable"
==== Gestão de Frota ====
* '''ISrvGtiFleetGet.GetVehiclesBrands():''' Marcas de veículos[cite: 263].
* '''ISrvGtiFleetGet.GetVehiclesModels():''' Modelos de veículos[cite: 263].
* '''ISrvGtiFleetGet.GetVehiclesClassType():''' Classes de viaturas[cite: 266].


! Campo !! Descrição
=== Estrutura de Dados Exemplo ===
filter
Muitos serviços devolvem um objeto do tipo `QTableGridDataSource`, que contém uma coleção de linhas (`Rows`) e o número total de registos (`TotalRows`)[cite: 286, 330].
-
companyIds
-
cultureInfo
-
timeZoneOffset / timeZoneId
-
currentPage / pageNumber
-
pageSize / rowsPerPage
-
sortColumnName
-
sortDirection
-
userName
-
password
-
token
}
 
=== Estrutura de Resposta ===
 
Normalmente:


==== Exemplo: PartnerCodeFamily ====
{| class="wikitable"
{| class="wikitable"
! Campo !! Tipo !! Descrição
|-
| PartnerCodeFamilyId || Int || ID único da gama [cite: 293]
|-
| Code || String || Código identificador (ex: "QAE.INT") [cite: 293]
|-
| Description || String || Descrição (ex: "QUATENUS ASSET EDITION") [cite: 293]
|-
| InsertedDate || String || Data de criação formatada conforme a cultura [cite: 293]
|}


! Campo !! Descrição
=== Configurações Suportadas ===
Rows
A plataforma suporta múltiplas culturas (ex: `pt-PT`, `pt-BR`, `en-US`) e fusos horários globais[cite: 283, 340].
-
TotalRows
}
 
== 📦 Exemplos de Serviços ==
 
=== SrvGovernmentGet.GetPartnerCodesFamilies ===
 
Obtém gamas de produtos.
 
==== Retorno ====
 
PartnerCodeFamilyId
Code
Description
Type (B2B / B2C)
 
=== ISrvGtiAssetGet.GetAssetBrands ===
 
Obtém marcas de dispositivos.
 
==== Retorno ====
 
AssetBrandId
Name
Origin (Global / Local)
 
=== ISrvGtiAssetGet.GetAssetModels ===
 
Obtém modelos de dispositivos.
 
==== Notas ===
 
Pode filtrar por tipo (mobile, computer, machine)
Pode filtrar ativos/inativos
 
=== ISrvGtiFleetGet.GetVehiclesBrands ===
 
Obtém marcas de viaturas.
 
=== ISrvGtiFleetGet.GetVehiclesModels ===
 
Obtém modelos de viaturas.
 
Inclui:
 
Dados técnicos (motor, consumo, dimensões)
Marca associada
Categoria e classe
 
=== QbmItemsServices.GetLicensableItems ===
 
Obtém produtos licenciáveis QBM.
 
==== Filtros avançados ===
 
Formato JSON:
 
<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code>
 
==== Retorno ===
 
Code
Description
ItemType (Produto / Serviço)
UnitPrice
TaxRate
Discount
 
=== QbmItemsServices.GetLicensableItemExtras ===
 
Obtém extras associados a um item.
 
=== QbmItemsServices.GetDeviceClasses ===
 
Obtém tipos de ativos.
 
Exemplos:
 
VEHICLE
MOTORCYCLE
 
=== IEntity.GetCustomers ===
 
Obtém clientes externos.
 
==== Filtros disponíveis ===
 
Estado (ACTIVE / INACTIVE)
VIP
País
Data última atualização
 
==== Informação retornada ===
 
Dados de faturação
Métodos de pagamento
Contactos
Moeda
Estado (ativo/inativo)
 
== ⚙️ Serviços Auxiliares ==
 
Incluem:
 
Países
Regiões
Moedas
Idiomas
Fusos horários
 
== 📎 Notas Importantes ==
 
⚠️ Os endpoints podem variar consoante a infraestrutura
 
⚠️ Alguns serviços exigem parâmetros obrigatórios dependendo da configuração
 
⚠️ Datas devem respeitar formato e timezone definidos
 
== 🧩 Apêndices ==
 
Lista de fusos horários suportados
Lista de culturas suportadas


{{QuatenusFooter}}
[[Categoria:Documentação Técnica]]
[[Categoria:Web Services]]
[[Categoria:Quatenus]]

Latest revision as of 15:26, 28 April 2026

Template:Página de Documentação Técnica

Web Services Quatenus® Core

O Quatenus Core é uma plataforma de localização inteligente mundial (WWIL) que disponibiliza uma série de Web Services para a obtenção de dados de licenciamento, gestão de ativos e frotas[cite: 185, 186, 189].

Endereços e Autenticação (Servidores de Produção)

Os serviços estão organizados por categorias e podem ser acedidos através dos seguintes endpoints WSDL (Infraestrutura Brasil)[cite: 213, 223]:

Serviço Categoria URL de Produção (WSDL)
QDats Licenciamento e Gamas http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl [cite: 215]
QDats Ativos (Assets) http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl [cite: 217]
QDats Viaturas e Combustíveis http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl [cite: 221]
QBMDats Itens e Serviços http://services.quatenus-system.com.br/quatenus10/QBMDats/Business/QbmItems/QbmltemsServices.svc?wsdl [cite: 231]
QBMDats Entidades (Clientes/Parceiros) http://services.quatenus-system.com.br/quatenus10/QBMDats/Administration/Entities/Entity.svc?wsdl [cite: 236]
QBMDats Documentos (Contratos/Propostas) http://services.quatenus-system.com.br/quatenus10/QBMDats/Documents/Document.svc?wsdl [cite: 242]

Dados para Testes

Para chamadas de teste, devem ser utilizados os seguintes argumentos de autenticação[cite: 249]:

  • userName: agoraqbmadmin@testesst.pt [cite: 249]
  • password: Ipiranga2013 [cite: 249]

Principais Métodos Disponíveis

Abaixo estão listados alguns dos métodos fundamentais para integração[cite: 256]:

Gamas e Dispositivos

  • SrvGovernmentGet.GetPartnerCodesFamilies(): Obtém a lista de gamas de produtos[cite: 258, 282].
  • ISrvGtiAssetGet.GetAssetBrands(): Obtém a lista de marcas de dispositivos[cite: 262, 326].
  • ISrvGtiAssetGet.GetAssetModels(): Lista de modelos de dispositivos[cite: 338].

Gestão de Frota

  • ISrvGtiFleetGet.GetVehiclesBrands(): Marcas de veículos[cite: 263].
  • ISrvGtiFleetGet.GetVehiclesModels(): Modelos de veículos[cite: 263].
  • ISrvGtiFleetGet.GetVehiclesClassType(): Classes de viaturas[cite: 266].

Estrutura de Dados Exemplo

Muitos serviços devolvem um objeto do tipo `QTableGridDataSource`, que contém uma coleção de linhas (`Rows`) e o número total de registos (`TotalRows`)[cite: 286, 330].

Exemplo: PartnerCodeFamily

Campo Tipo Descrição
PartnerCodeFamilyId Int ID único da gama [cite: 293]
Code String Código identificador (ex: "QAE.INT") [cite: 293]
Description String Descrição (ex: "QUATENUS ASSET EDITION") [cite: 293]
InsertedDate String Data de criação formatada conforme a cultura [cite: 293]

Configurações Suportadas

A plataforma suporta múltiplas culturas (ex: `pt-PT`, `pt-BR`, `en-US`) e fusos horários globais[cite: 283, 340].

Categoria:Documentação Técnica Categoria:Web Services Categoria:Quatenus

Retrieved from "https://quatenuswiki.ddns.net/index.php?title=Webservicesqmb&oldid=369"