Webservicesqmb: Difference between revisions

From QuatenusWiki
← Older edit
VisualWikitext
No edit summary
No edit summary
 
Line 1: Line 1:
{{QuatenusHeader}}
{{Página de Documentação Técnica}}


= GetLicensableItems =
== 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].


== 📌 Descrição ==
=== Endereços e Autenticação (Servidores de Produção) ===
Este serviço obtém uma lista de produtos QBM que correspondem a produtos licenciáveis das gamas Quatenus.
Os serviços estão organizados por categorias e podem ser acedidos através dos seguintes endpoints WSDL (Infraestrutura Brasil)[cite: 213, 223]:
 
---
 
== 🌐 Endpoint ==
<code>
.../QbmItemsServices.svc/GetLicensableItems
</code>
 
---
 
== 🔐 Autenticação ==
* userName
* password
* token
 
---
 
== 📥 Parâmetros ==


{| class="wikitable"
{| class="wikitable"
! Nome !! Tipo !! Obrigatório !! Descrição !! Valor por omissão !! Exemplo
! Serviço !! Categoria !! URL de Produção (WSDL)
|-
| filter || String || ❌ || Filtro de pesquisa || "" || Fleet
|-
| familyIds || String || ❌ || Lista de IDs de gamas || "" || 114
|-
| cultureInfo || String || ❌ || Cultura do servidor || pt-PT || en-US
|-
| timeZoneId || String || ❌ || Fuso horário || GMT || GMT Standard Time
|-
| pageNumber || String || ❌ || Página atual || "" || 1
|-
| rowsPerPage || String || ❌ || Nº registos || "" || 100
|-
| sortColumnName || String || ❌ || Coluna de ordenação || Code || Description
|-
| sortDirection || String || ❌ || Direção ordenação || ascending || descending
|-
| requestDate || String || ❌ || Data cálculo preço || 0001-01-01 00:00 || 2013-12-04 00:00
|-
| currencyId || String || ❌ || Moeda || 0 || 50
|-
|-
| fromBusinessEntityId || String || ❌ || Entidade fornecedora || 0 || 123
| QDats || Licenciamento e Gamas || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl [cite: 215]
|-
|-
| toBusinessEntityId || String || ❌ || Entidade cliente || "" || 123
| QDats || Ativos (Assets) || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl [cite: 217]
|-
|-
| userName || String || ✔ || Login || - || user@test.com
| QDats || Viaturas e Combustíveis || http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl [cite: 221]
|-
|-
| password || String || ✔ || Password || - || *****
| QBMDats || Itens e Serviços || http://services.quatenus-system.com.br/quatenus10/QBMDats/Business/QbmItems/QbmltemsServices.svc?wsdl [cite: 231]
|-
|-
| token || String || ❌ || Token || - || -
| QBMDats || Entidades (Clientes/Parceiros) || http://services.quatenus-system.com.br/quatenus10/QBMDats/Administration/Entities/Entity.svc?wsdl [cite: 236]
|-
|-
| args || JSON || ❌ || Filtros avançados || - || ver abaixo
| 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]:
== ⚙️ Filtros Avançados (args) ==
* '''userName:''' agoraqbmadmin@testesst.pt [cite: 249]
 
* '''password:''' Ipiranga2013 [cite: 249]
Formato JSON:
 
<syntaxhighlight lang="json">
{
  "Data": {
    "Global": "",
    "Extra": "",
    "Units": "",
    "ItemTypes": "",
    "IsEnabledFilter": "ALL",
    "HasPriceFilter": "",
    "IsLicensedFilter": ""
  }
}
</syntaxhighlight>
 
---
 
== 📊 Valores Possíveis ==
 
=== Units ===
* B – Box 
* M – Month 
* Y – Year 
* U – Unit 
* L – License 
* D – Devices 
 
=== ItemTypes ===
* P – Produto 
* S – Serviço 
 
=== IsEnabledFilter ===
* ACTIVE 
* INACTIVE 
* ALL 


=== IsLicensedFilter ===
=== Principais Métodos Disponíveis ===
* LICENSED 
Abaixo estão listados alguns dos métodos fundamentais para integração[cite: 256]:
* UNLICENSED 
* ALL 


=== Currency ===
==== Gamas e Dispositivos ====
* 50 – EUR 
* '''SrvGovernmentGet.GetPartnerCodesFamilies():''' Obtém a lista de gamas de produtos[cite: 258, 282].
* 21 – BRL 
* '''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].


== 📤 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].
Tipo: <code>PagedData&lt;QbmLicensableItemObject&gt;</code>


==== Exemplo: PartnerCodeFamily ====
{| class="wikitable"
{| class="wikitable"
! Campo !! Tipo !! Descrição
! Campo !! Tipo !! Descrição
|-
|-
| Rows || object[] || Lista de items
| PartnerCodeFamilyId || Int || ID único da gama [cite: 293]
|-
| TotalRows || int || Total de registos
|}
 
---
 
== 📄 Estrutura do Objeto ==
 
{| class="wikitable"
! Campo !! Tipo !! Nullable !! Descrição
|-
| Code || String || ❌ || Código do item
|-
| Description || String || ❌ || Descrição
|-
| IsEnabled || Bool || ❌ || Item ativo
|-
| ItemType || Char || ❌ || Tipo (P/S)
|-
| PartnerCodeColor || String || ✔ || Cor
|-
| InsertedUser || String || ❌ || Criador
|-
| PartnerCodeFamilyId || Int || ✔ || ID da gama
|-
| PartnersCodeIsExtra || Bool || ✔ || É extra
|-
| PartnersCodeIsGlobal || Bool || ✔ || É global
|-
| PartnersCodeUnit || String || ✔ || Unidade
|-
| QbmItemId || Int || ❌ || ID do item
|-
| ShortDescription || String || ✔ || Descrição curta
|-
| Unit || Int || ✔ || Unidade de preço
|-
| UnitPrice || Decimal || ✔ || Preço
|-
| Discount || Decimal || ✔ || Desconto
|-
| TaxRate || Decimal || ✔ || IVA
|-
| CheckBox || Bool || ❌ || Campo técnico
|-
| DataAction || Object || ❌ || Interno
|-
| DataObjectDescription || String || ❌ || Interno
|-
| DataSource || Object || ❌ || Interno
|-
|-
| GridIndex || Int || ❌ || Interno
| Code || String || Código identificador (ex: "QAE.INT") [cite: 293]
|-
|-
| Id || String || ❌ || Interno
| Description || String || Descrição (ex: "QUATENUS ASSET EDITION") [cite: 293]
|-
|-
| UsageHistoryId || String || ✔ || Interno
| 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].
== 🧪 Exemplo ==
 
<code>
.../GetLicensableItems?selectedLanguage=pt-PT&timeZoneId=GMT&userName=xxx&password=xxx
</code>
 
---
 
== ⚠️ Notas ==
 
* requestDate deve estar no formato: yyyy-MM-dd HH:mm 
* args é obrigatório em alguns cenários 
* Filtros podem impactar preços calculados 


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