Usage Guide

8 min

The Data Gateway provides a unified interface for tenant and product data across SHI Cloud. This guide describes the available modules, what they do, and how they map to backend services.

Overview

With Data Gateway you can:

Run AI-assisted queries on licensing and compliance data

Manage tenant metadata (rename, associate, disassociate)

Retrieve processed relational data from Azure SQL Database

Access bulk reports and update package data in Azure Blob Storage

Automate these operations through the public API

Features

LicenseGPT

Conversational interface for licensing and compliance analysis

Uses the API endpoint POST /Api/Chat/LicenseGpt

Combines data from Azure SQL Database (processed relational data) and Azure Blob Storage (bulk + update packages)

Can surface agentic actions, such as: - Retrieve License Report - Get Correlation IDs

Designed for compliance validation and license usage insights without writing queries

graph TB;
  User([User - Browser])
  UI["LicenseGPT (UI)"]

  subgraph DG["Data Gateway API"]
    ChatEP{{"/Api/Chat/LicenseGpt"}}
  end

  subgraph Data["Data Sources"]
    SQL[("Azure SQL Database - Processed Data")]
    Blob[/"Azure Blob Storage - Bulk & Updates"\]
  end

  User --> UI
  UI -->|Prompt| ChatEP
  ChatEP --> SQL
  ChatEP --> Blob
  ChatEP -->|Response JSON| UI

ℹ️ Use case

LicenseGPT allows teams to validate license compliance without writing queries or exporting raw data. It reduces manual effort by providing natural-language answers and direct report retrieval, ensuring faster insights for audits and optimization.

Tenant Manager

Displays tenant metadata: Tenant ID, Display Name, Parent association

Supports three operations:

Rename → PATCH /Api/Tenant/{id} to update the display name

Associate → PATCH /Api/Tenant/{id} to set a parent tenant ID

Disassociate → PATCH /Api/Tenant/{id} to clear the parent reference

All operations persist to the backend database and are reflected in downstream reporting

flowchart LR;
  UI["Tenant Manager (UI)"] --> API{{"Data Gateway API (/Api/Tenant)"}}
  API --> SQL[("Azure SQL Database - Tenant Records")]

ℹ️ Use case

Tenant Manager ensures tenant data remains consistent and structured across SHI Cloud. By maintaining correct naming and parent relationships, organizations avoid reporting errors and ensure accurate compliance analysis.

API Access

For automation and integration, use the public OpenAPI specification:

API Reference: https://specs.shilab.com

Key endpoints:

POST /Api/Chat/LicenseGpt - AI-assisted licensing queries

GET /Api/Tenant - retrieve tenant metadata

PATCH /Api/Tenant/{tenantId} - rename, associate, or disassociate tenants

Endpoints for bulk report retrieval and update package resolution (see Swagger)

GET /Api/Core/Health - health check

All requests require authentication with Entra ID tokens passed as HTTPS bearer tokens, except for the health check.

Data GatewayData Gateway

DeploymentDeployment

InfrastructureInfrastructure

API Reference