Webservicesqmb: Difference between revisions

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


= Web Services Quatenus® Core =
== 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) ===
Documentação dos Web Services do Quatenus® Core para integração e obtenção de dados.
Os serviços estão organizados por categorias e podem ser acedidos através dos seguintes endpoints WSDL (Infraestrutura Brasil)[cite: 213, 223]:
 
Versão: 12.00
Fonte:
 
== 🧭 Estrutura ==
 
=== 📦 Licenciamento ===
 
[[QBM/WebServices/GetPartnerCodesFamilies]]
[[QBM/WebServices/GetLicensableItems]]
[[QBM/WebServices/GetLicensableItemExtras]]
 
=== 📱 Ativos ===
 
[[QBM/WebServices/GetAssetBrands]]
[[QBM/WebServices/GetAssetModels]]
[[QBM/WebServices/GetDeviceClasses]]
 
=== 🚗 Frota ===
 
[[QBM/WebServices/GetVehiclesBrands]]
[[QBM/WebServices/GetVehiclesModels]]
[[QBM/WebServices/GetVehiclesClassType]]
[[QBM/WebServices/GetFuelTypes]]
 
=== 👤 Entidades ===
 
[[QBM/WebServices/GetCustomers]]
[[QBM/WebServices/GetPartners]]
 
=== 📄 Documentos ===
 
[[QBM/WebServices/GetExternalContracts]]
[[QBM/WebServices/GetBillingEvents]]
 
=== 💰 Pagamentos ===
 
[[QBM/WebServices/GetPaymentTerms]]
 
== 🔐 Autenticação ==
 
Parâmetros comuns:


{| class="wikitable"
{| class="wikitable"
 
! Serviço !! Categoria !! URL de Produção (WSDL)
! Campo !! Descrição
|-
userName
| QDats || Licenciamento e Gamas || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl [cite: 215]
-
|-
password
| QDats || Ativos (Assets) || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl [cite: 217]
-
token
}
 
{{QuatenusFooter}}
 
🧩 Template Base (para cada serviço)
 
Usa isto como padrão para todas as páginas 👇
 
{{QuatenusHeader}}
 
= <Nome do Serviço> =
 
== 📌 Descrição ==
Descrição funcional do serviço.
 
---
 
== 🌐 Endpoint ==
 
<code>
URL_DO_SERVIÇO
</code>
 
---
 
== 🔐 Autenticação ==
 
* userName 
* password 
* token (opcional)
 
---
 
== 📥 Parâmetros ==
 
{| class="wikitable"
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo
|-
|-
| filter || string || ❌ || Filtro de pesquisa || "Fleet"
| QDats || Viaturas e Combustíveis || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl [cite: 221]
|}
 
---
 
== 📤 Resposta ==
 
{| class="wikitable"
! Campo !! Tipo !! Descrição
|-
|-
| Rows || object[] || Lista de resultados
| QBMDats || Itens e Serviços || http://services.quatenus-system.com.br/quatenus10/QBMDats/Business/QbmItems/QbmltemsServices.svc?wsdl [cite: 231]
|-
|-
| TotalRows || int || Total de registos
| QBMDats || Entidades (Clientes/Parceiros) || http://services.quatenus-system.com.br/quatenus10/QBMDats/Administration/Entities/Entity.svc?wsdl [cite: 236]
|}
 
---
 
== 📄 Estrutura do Objeto ==
 
{| class="wikitable"
! Campo !! Tipo !! Descrição
|-
|-
| Id || int || Identificador
| 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]:
== 🧪 Exemplo ==
* '''userName:''' agoraqbmadmin@testesst.pt [cite: 249]
 
* '''password:''' Ipiranga2013 [cite: 249]
<code>
URL_EXEMPLO
</code>
 
---
 
== ⚠️ Notas ==
 
* Observações importantes
 
---
 
{{QuatenusFooter}}
🔧 Exemplo Real (já pronto)
👉 GetLicensableItems
 
{{QuatenusHeader}}
 
= GetLicensableItems =
 
== 📌 Descrição ==
Obtém lista de produtos QBM licenciáveis.
 
== 🌐 Endpoint ==
 
<code> .../QbmItemsServices.svc/GetLicensableItems </code>
 
== 📥 Parâmetros ==
 
{| class="wikitable"


! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo
=== Principais Métodos Disponíveis ===
filter
Abaixo estão listados alguns dos métodos fundamentais para integração[cite: 256]:
-
familyIds
-
currencyId
-
requestDate
-
args
}


== ⚙️ Filtros Avançados (args) ==
==== 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].


<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code>
==== 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].


== 📤 Resposta ==
=== 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 ====
{| class="wikitable"
{| class="wikitable"
! Campo !! Tipo !! Descrição
! Campo !! Tipo !! Descrição
Rows
|-
-
| PartnerCodeFamilyId || Int || ID único da gama [cite: 293]
TotalRows
|-
}
| Code || String || Código identificador (ex: "QAE.INT") [cite: 293]
 
|-
== 📄 Estrutura do Objeto ==
| Description || String || Descrição (ex: "QUATENUS ASSET EDITION") [cite: 293]
 
|-
{| class="wikitable"
| InsertedDate || String || Data de criação formatada conforme a cultura [cite: 293]
 
|}
! Campo !! Tipo !! Descrição
Code
-
Description
-
ItemType
-
UnitPrice
-
TaxRate
}
 
== 🧪 Exemplo ==
 
<code> .../GetLicensableItems?userName=xxx&password=xxx </code>
 
== ⚠️ Notas ==


Pode usar filtros por unidade (M, Y, U, etc.)
=== Configurações Suportadas ===
Pode filtrar por produtos ou serviços
A plataforma suporta múltiplas culturas (ex: `pt-PT`, `pt-BR`, `en-US`) e fusos horários globais[cite: 283, 340].


{{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"