Webservicesqmb: Difference between revisions

From QuatenusWiki
VisualWikitext
Created page with "<nowiki>{{QuatenusHeader}}</nowiki> <nowiki>= Web Services Quatenus® Core – Licenciamento =</nowiki> <nowiki>== 📌 Introdução ==</nowiki> 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 == <nowiki>=== QDats ===</nowiki> * Licenciamento (Gamas) <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/..."
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<nowiki>{{QuatenusHeader}}</nowiki>
{{Página de Documentação Técnica}}


<nowiki>= Web Services Quatenus® Core – Licenciamento =</nowiki>
== 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].


<nowiki>== 📌 Introdução ==</nowiki>
=== 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 ==
<nowiki>=== QDats ===</nowiki>
* Licenciamento (Gamas) <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl</nowiki><nowiki></code></nowiki>
* Ativos <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl</nowiki><nowiki></code></nowiki>
* Viaturas <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl</nowiki><nowiki></code></nowiki>
----=== QBMDats ===
* Items / Extras <nowiki><code>.../QBMDats/Business/QbmItems/QbmItemsServices.svc?wsdl</code></nowiki>
* Entidades <nowiki><code>.../QBMDats/Administration/Entities/Entity.svc?wsdl</code></nowiki>
* Documentos <nowiki><code>.../QBMDats/Documents/Document.svc?wsdl</code></nowiki>
* Payment Terms <nowiki><code>.../QbmDats/Business/PaymentTerms/PaymentTermsServices.svc?wsdl</code></nowiki>
----=== 🔐 Autenticação ===
Parâmetros comuns:
<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
{| class="wikitable"
!<nowiki>! Parâmetro !! Descrição</nowiki>
! Serviço !! Categoria !! URL de Produção (WSDL)
|-
|companyId
|-
| -
|-
|deviceIds
|-
| -
|-
|-
|userName
| 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]
|-
|-
|password
| 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]
|-
|-
|token
| 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]
|}
|}
----== 🧪 Serviços Disponíveis ==
<nowiki>=== 📦 Gamas ===</nowiki>
* <nowiki><code>SrvGovernmentGet.GetPartnerCodesFamilies()</code></nowiki>
<nowiki>=== 📱 Dispositivos ===</nowiki>
* <nowiki><code>ISrvGtiAssetGet.GetAssetBrands()</code></nowiki>
* <nowiki><code>ISrvGtiAssetGet.GetAssetModels()</code></nowiki>
<nowiki>=== 🚗 Viaturas ===</nowiki>
* <nowiki><code>ISrvGtiFleetGet.GetVehiclesBrands()</code></nowiki>
* <nowiki><code>ISrvGtiFleetGet.GetVehiclesModels()</code></nowiki>
* <nowiki><code>ISrvGtiFleetGet.GetVehiclesClassType()</code></nowiki>
* <nowiki><code>ISrvGtiFleetGet.GetFuelTypes()</code></nowiki>
<nowiki>=== 📦 Items ===</nowiki>
* <nowiki><code>QbmItemsServices.GetLicensableItems()</code></nowiki>
* <nowiki><code>QbmItemsServices.GetLicensableItemExtras()</code></nowiki>
* <nowiki><code>QbmItemsServices.GetDeviceClasses()</code></nowiki>
<nowiki>=== 👤 Entidades ===</nowiki>


* <nowiki><code>IEntity.GetCustomers()</code></nowiki>
==== Dados para Testes ====
* <nowiki><code>IEntity.GetPartners()</code></nowiki>
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]


<nowiki>=== 📄 Documentos ===</nowiki>
=== Principais Métodos Disponíveis ===
Abaixo estão listados alguns dos métodos fundamentais para integração[cite: 256]:


* <nowiki><code>IDocument.GetExternalContracts()</code></nowiki>
==== Gamas e Dispositivos ====
* <nowiki><code>IDocument.GetExternalBillingEvents()</code></nowiki>
* '''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].


<nowiki>=== 💰 Pagamentos ===</nowiki>
==== 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].


* <nowiki><code>IPaymentTermsServices.GetPaymentTermsExternal()</code></nowiki>
=== 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].


----== 🔎 Estrutura Geral dos Serviços ==
==== Exemplo: PartnerCodeFamily ====
 
A maioria dos serviços segue o mesmo padrão:
 
<nowiki>=== Argumentos Comuns ===</nowiki>
 
<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
{| class="wikitable"
!<nowiki>! Campo !! Descrição</nowiki>
! Campo !! Tipo !! Descrição
|-
|filter
|-
| -
|-
|companyIds
|-
| -
|-
|cultureInfo
|-
| -
|-
|timeZoneOffset / timeZoneId
|-
| -
|-
|currentPage / pageNumber
|-
|-
| -
| PartnerCodeFamilyId || Int || ID único da gama [cite: 293]
|-
|-
|pageSize / rowsPerPage
| Code || String || Código identificador (ex: "QAE.INT") [cite: 293]
|-
|-
| -
| Description || String || Descrição (ex: "QUATENUS ASSET EDITION") [cite: 293]
|-
|-
|sortColumnName
| InsertedDate || String || Data de criação formatada conforme a cultura [cite: 293]
|-
| -
|-
|sortDirection
|-
| -
|-
|userName
|-
| -
|-
|password
|-
| -
|-
|token
|-
| }
|}
|}
----=== Estrutura de Resposta ===
Normalmente:
<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
!<nowiki>! Campo !! Descrição</nowiki>
|-
|Rows
|-
| -
|-
|TotalRows
|-
| }
|}
----== 📦 Exemplos de Serviços ==
<nowiki>=== SrvGovernmentGet.GetPartnerCodesFamilies ===</nowiki>
Obtém gamas de produtos.
<nowiki>==== Retorno ====</nowiki>
* PartnerCodeFamilyId
* Code
* Description
* Type (B2B / B2C)
----=== ISrvGtiAssetGet.GetAssetBrands ===
Obtém marcas de dispositivos.
<nowiki>==== Retorno ====</nowiki>
* AssetBrandId
* Name
* Origin (Global / Local)
----=== ISrvGtiAssetGet.GetAssetModels ===
Obtém modelos de dispositivos.
<nowiki>==== Notas ===</nowiki>
* 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.
<nowiki>==== Filtros avançados ===</nowiki>
Formato JSON:
<nowiki><code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code></nowiki>
<nowiki>==== Retorno ===</nowiki>
* 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.
<nowiki>==== Filtros disponíveis ===</nowiki>
* Estado (ACTIVE / INACTIVE)
* VIP
* País
* Data última atualização
<nowiki>==== Informação retornada ===</nowiki>
* 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
=== Configurações Suportadas ===
* Lista de culturas suportadas
A plataforma suporta múltiplas culturas (ex: `pt-PT`, `pt-BR`, `en-US`) e fusos horários globais[cite: 283, 340].


----<nowiki>{{QuatenusFooter}}</nowiki>
[[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"