Webservicesqmb: Difference between revisions

From QuatenusWiki
No edit summary
No edit summary
Line 1: Line 1:
{{QuatenusHeader}}
{{QuatenusHeader}}


= Web Services Quatenus® Core – Licenciamento =
= Web Services Quatenus® Core =


== 📌 Introdução ==
== 📌 Introdução ==
 
Documentação dos Web Services do Quatenus® Core para integração e obtenção de dados.
Este documento descreve os Web Services do Quatenus® Core para obtenção de dados de licenciamento.


Versão: 12.00
Versão: 12.00
Data: Outubro 2025
Fonte:
Fonte:


== 🌐 Endereços e Autenticação ==
== 🧭 Estrutura ==
 
=== 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"
 
! Parâmetro !! Descrição
companyId
-
deviceIds
-
userName
-
password
-
token
}
 
== 🧪 Serviços Disponíveis ==
 
=== 📦 Gamas ===
 
<code>SrvGovernmentGet.GetPartnerCodesFamilies()</code>


=== 📱 Dispositivos ===
=== 📦 Licenciamento ===


<code>ISrvGtiAssetGet.GetAssetBrands()</code>
[[QBM/WebServices/GetPartnerCodesFamilies]]
<code>ISrvGtiAssetGet.GetAssetModels()</code>
[[QBM/WebServices/GetLicensableItems]]
[[QBM/WebServices/GetLicensableItemExtras]]


=== 🚗 Viaturas ===
=== 📱 Ativos ===


<code>ISrvGtiFleetGet.GetVehiclesBrands()</code>
[[QBM/WebServices/GetAssetBrands]]
<code>ISrvGtiFleetGet.GetVehiclesModels()</code>
[[QBM/WebServices/GetAssetModels]]
<code>ISrvGtiFleetGet.GetVehiclesClassType()</code>
[[QBM/WebServices/GetDeviceClasses]]
<code>ISrvGtiFleetGet.GetFuelTypes()</code>


=== 📦 Items ===
=== 🚗 Frota ===


<code>QbmItemsServices.GetLicensableItems()</code>
[[QBM/WebServices/GetVehiclesBrands]]
<code>QbmItemsServices.GetLicensableItemExtras()</code>
[[QBM/WebServices/GetVehiclesModels]]
<code>QbmItemsServices.GetDeviceClasses()</code>
[[QBM/WebServices/GetVehiclesClassType]]
[[QBM/WebServices/GetFuelTypes]]


=== 👤 Entidades ===
=== 👤 Entidades ===


<code>IEntity.GetCustomers()</code>
[[QBM/WebServices/GetCustomers]]
<code>IEntity.GetPartners()</code>
[[QBM/WebServices/GetPartners]]


=== 📄 Documentos ===
=== 📄 Documentos ===


<code>IDocument.GetExternalContracts()</code>
[[QBM/WebServices/GetExternalContracts]]
<code>IDocument.GetExternalBillingEvents()</code>
[[QBM/WebServices/GetBillingEvents]]


=== 💰 Pagamentos ===
=== 💰 Pagamentos ===


<code>IPaymentTermsServices.GetPaymentTermsExternal()</code>
[[QBM/WebServices/GetPaymentTerms]]


== 🔎 Estrutura Geral dos Serviços ==
== 🔐 Autenticação ==


A maioria dos serviços segue o mesmo padrão:
Parâmetros comuns:
 
=== Argumentos Comuns ===


{| class="wikitable"
{| class="wikitable"


! Campo !! Descrição
! Campo !! Descrição
filter
-
companyIds
-
cultureInfo
-
timeZoneOffset / timeZoneId
-
currentPage / pageNumber
-
pageSize / rowsPerPage
-
sortColumnName
-
sortDirection
-
userName
userName
-
-
Line 124: Line 58:
}
}


=== Estrutura de Resposta ===
{{QuatenusFooter}}


Normalmente:
🧩 Template Base (para cada serviço)


{| class="wikitable"
Usa isto como padrão para todas as páginas 👇


! Campo !! Descrição
{{QuatenusHeader}}
Rows
-
TotalRows
}


== 📦 Exemplos de Serviços ==
= <Nome do Serviço> =


=== SrvGovernmentGet.GetPartnerCodesFamilies ===
== 📌 Descrição ==
Descrição funcional do serviço.


Obtém gamas de produtos.
---


==== Retorno ====
== 🌐 Endpoint ==


PartnerCodeFamilyId
<code>
Code
URL_DO_SERVIÇO
Description
</code>
Type (B2B / B2C)


=== ISrvGtiAssetGet.GetAssetBrands ===
---


Obtém marcas de dispositivos.
== 🔐 Autenticação ==


==== Retorno ====
* userName 
* password 
* token (opcional) 


AssetBrandId
---
Name
Origin (Global / Local)


=== ISrvGtiAssetGet.GetAssetModels ===
== 📥 Parâmetros ==


Obtém modelos de dispositivos.
{| class="wikitable"
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo
|-
| filter || string || ❌ || Filtro de pesquisa || "Fleet"
|}


==== Notas ===
---


Pode filtrar por tipo (mobile, computer, machine)
== 📤 Resposta ==
Pode filtrar ativos/inativos


=== ISrvGtiFleetGet.GetVehiclesBrands ===
{| class="wikitable"
! Campo !! Tipo !! Descrição
|-
| Rows || object[] || Lista de resultados
|-
| TotalRows || int || Total de registos
|}


Obtém marcas de viaturas.
---


=== ISrvGtiFleetGet.GetVehiclesModels ===
== 📄 Estrutura do Objeto ==


Obtém modelos de viaturas.
{| class="wikitable"
! Campo !! Tipo !! Descrição
|-
| Id || int || Identificador
|}


Inclui:
---


Dados técnicos (motor, consumo, dimensões)
== 🧪 Exemplo ==
Marca associada
Categoria e classe


=== QbmItemsServices.GetLicensableItems ===
<code>
URL_EXEMPLO
</code>


Obtém produtos licenciáveis QBM.
---


==== Filtros avançados ===
== ⚠️ Notas ==


Formato JSON:
* Observações importantes


<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code>
---


==== Retorno ===
{{QuatenusFooter}}
🔧 Exemplo Real (já pronto)
👉 GetLicensableItems


Code
{{QuatenusHeader}}
Description
ItemType (Produto / Serviço)
UnitPrice
TaxRate
Discount


=== QbmItemsServices.GetLicensableItemExtras ===
= GetLicensableItems =


Obtém extras associados a um item.
== 📌 Descrição ==
Obtém lista de produtos QBM licenciáveis.


=== QbmItemsServices.GetDeviceClasses ===
== 🌐 Endpoint ==


Obtém tipos de ativos.
<code> .../QbmItemsServices.svc/GetLicensableItems </code>


Exemplos:
== 📥 Parâmetros ==


VEHICLE
{| class="wikitable"
MOTORCYCLE


=== IEntity.GetCustomers ===
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo
filter
-
familyIds
-
currencyId
-
requestDate
-
args
}


Obtém clientes externos.
== ⚙️ Filtros Avançados (args) ==


==== Filtros disponíveis ===
<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code>


Estado (ACTIVE / INACTIVE)
== 📤 Resposta ==
VIP
País
Data última atualização


==== Informação retornada ===
{| class="wikitable"


Dados de faturação
! Campo !! Tipo !! Descrição
Métodos de pagamento
Rows
Contactos
-
Moeda
TotalRows
Estado (ativo/inativo)
}


== ⚙️ Serviços Auxiliares ==
== 📄 Estrutura do Objeto ==


Incluem:
{| class="wikitable"


Países
! Campo !! Tipo !! Descrição
Regiões
Code
Moedas
-
Idiomas
Description
Fusos horários
-
 
ItemType
== 📎 Notas Importantes ==
-
 
UnitPrice
⚠️ Os endpoints podem variar consoante a infraestrutura
-
TaxRate
}


⚠️ Alguns serviços exigem parâmetros obrigatórios dependendo da configuração
== 🧪 Exemplo ==


⚠️ Datas devem respeitar formato e timezone definidos
<code> .../GetLicensableItems?userName=xxx&password=xxx </code>


== 🧩 Apêndices ==
== ⚠️ Notas ==


Lista de fusos horários suportados
Pode usar filtros por unidade (M, Y, U, etc.)
Lista de culturas suportadas
Pode filtrar por produtos ou serviços


{{QuatenusFooter}}
{{QuatenusFooter}}

Revision as of 15:20, 28 April 2026

Web Services Quatenus® Core

📌 Introdução

Documentação dos Web Services do Quatenus® Core para integração e obtenção de dados.

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:

Campo Descrição

userName - password - token }






🧩 Template Base (para cada serviço)

Usa isto como padrão para todas as páginas 👇

<Nome do Serviço>

📌 Descrição

Descrição funcional do serviço.

---

🌐 Endpoint

URL_DO_SERVIÇO

---

🔐 Autenticação

  • userName
  • password
  • token (opcional)

---

📥 Parâmetros

Nome Tipo Obrigatório Descrição Exemplo
filter string Filtro de pesquisa "Fleet"

---

📤 Resposta

Campo Tipo Descrição
Rows object[] Lista de resultados
TotalRows int Total de registos

---

📄 Estrutura do Objeto

Campo Tipo Descrição
Id int Identificador

---

🧪 Exemplo

URL_EXEMPLO

---

⚠️ Notas

  • Observações importantes

---






🔧 Exemplo Real (já pronto) 👉 GetLicensableItems

GetLicensableItems

📌 Descrição

Obtém lista de produtos QBM licenciáveis.

🌐 Endpoint

.../QbmItemsServices.svc/GetLicensableItems

📥 Parâmetros

Nome Tipo Obrigatório Descrição Exemplo

filter - familyIds - currencyId - requestDate - args }

⚙️ Filtros Avançados (args)

{ "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } }

📤 Resposta

Campo Tipo Descrição

Rows - TotalRows }

📄 Estrutura do Objeto

Campo Tipo Descrição

Code - Description - ItemType - UnitPrice - TaxRate }

🧪 Exemplo

.../GetLicensableItems?userName=xxx&password=xxx

⚠️ Notas

Pode usar filtros por unidade (M, Y, U, etc.) Pode filtrar por produtos ou serviços