API Overview

The IZO™+ Multi Cloud Connect API lets you run the same ordering journey available in the TC^x Portal directly from your own systems. Over a single REST base URL, secured with a bearer token, you can validate a location, qualify a solution, generate and review a quote, place an order, and manage live services. Every request and response is JSON.

What the API is for

The API exposes the IZO™+ Multi Cloud Connect quote-to-order journey as a set of REST endpoints. It is intended for customers and integration partners who want to embed ordering into their own provisioning tools, portals, or service catalogues rather than working solely through the TC^x Portal.

The endpoints fall into six functional areas, which together follow the natural sequence of placing and managing an order:

Area	What it does
Geographic Address Management	Validates your location and legal-entity context and returns the eligible data-centre cities, supported cloud providers, and access types.
Product Offering Qualification (POQ)	Submits a solution specification (access ports, cloud connections, and routing components) for feasibility and pricing, and returns a quoteCode.
Quote Management	Retrieves, updates, checks the validation status of, checks out, and downloads a quote.
Inventory & Product Catalog	Reference helpers: data-centre locations, catalogue picklists, supported components, and details for individual access-port, cloud-connection, TCR, and GVPN inventory items.
Ordering Management	Contracting and legal-entity details, billing contacts, credit status, order placement, the Customer Order Form (COF), and a view of ordered services.
MACD Management	Move, Add, Change, Delete: raises a change quote against a live service to adjust bandwidth, and submits terminations.

The architecture behind the API

Your applications and IT stacks interact with the Tata Communications digital platform through a Kong API Gateway, which exposes the MEF-compliant, customer-facing APIs. These cover the key functions of Ordering, Feasibility & Quote, MACD (Move, Add, Change, Delete), and Service Termination.

The Kong gateway connects to the Akana Gateway, which mediates to the backend BSS/OSS stack and business logic. That backend handles the processes behind each order: legal-entity validation, location checks, product and bandwidth selection, interface type, CPE selection, quote generation, and the overall ordering journey. The private Tata Communications backbone underpins the services these orders provision.

What the API delivers

The programmable layer is designed to give you:

Agility, visibility, and performance: on-demand ordering and real-time insight from your own tools.
Reduced technology debt: platform changes and replacements are absorbed behind a stable API contract.
OPEX-based cost management: connectivity and CPE are consumed as cloud-style services.
Scalable, flexible assurance: application assurance that stays aligned with your business outcomes.

The intent is a secure, future-proofed self-service channel so you can consume IZO™+ Multi Cloud Connect services directly from your own IT stack, with the flexibility and agility of programmatic control.

Base URL and versioning

All endpoints are served from a single base URL:

https://api.tatacommunications.com/gnsapi/izomcc/v1

Requests use HTTPS on the standard port (443). Every path in this section is relative to that base: for example, POST /geo means POST: https://api.tatacommunications.com/gnsapi/izomcc/v1/geo.

Request and response conventions

Format. Requests with a body and all responses are JSON (Content-Type: application/json).
Authentication. Every endpoint requires a bearer token in the Authorization header. See Authentication and Tokens.
Service model. The mccFlavour field selects the service model: IZO™+ Multi Cloud Connect Direct or IZO™+ Multi Cloud Connect Flex.
Identifiers. The journey threads a small set of identifiers through each step. The most important are:

Identifier	Meaning	Example
legalEntityId	The contracting customer entity	8501
addressValidationId	Returned by Geographic Address Validation; the entry token for qualification	CUSTID2026032516371414
quoteCode	The quote created by qualification; used across quote and order steps	IZOMCC250326FWAW
fpUUID / cloudUUID / tcrUUID	Component identifiers for an access port, cloud connection, or TCR row	FP000000000106824986 / VCC00000000106824988 / TCR00000000106824987
solutionServiceId	A live, ordered service; the entry point for MACD changes	IZOMCCSOLN0000013190
macdQuoteCode	A change quote raised against a live service	IZOMCC280426W75Y

The order journey at a glance

A typical new order follows this sequence:

Validate the location and entity: POST /geo.
Qualify the solution: POST /productOfferingQualification → returns a quoteCode and component UUIDs.
Review the quote and component validation: GET /quote/{quoteCode}, GET /quote/validationStatus.
Refine if needed: PUT /productOfferingQualification/{quoteCode}, POST /productOfferingQualification/delete, PUT /quote/{quoteCode}.
Check out the quote: GET /quote/checkout.
Contract: contracting details, billing contact, and contracting selections under /order.
Place the order: POST /order/placeOrder → returns an orderCode and the COF.
Operate: list live services with GET /order/getServiceInventory, then use MACD endpoints to change or terminate them.

Each step is shown end-to-end, with example requests and responses, in Request and Response Examples. The complete endpoint catalogue is in the Endpoints Reference.

Error handling

The API uses standard HTTP status codes:

200 (Success)
400 (Bad request)
401 (Unauthorised)
500 (Internal error)

Error responses carry a small JSON object so your integration can surface a meaningful message and log a reference. The full error model is described in API Errors and Codes.

Relationship to the TC^x Portal

The API and the TC^x Portal drive the same underlying ordering engine. Anything you order through the API appears in your service inventory exactly as a portal order would, and vice versa. You can mix the two: for example, qualify and order through the API, then track delivery in the portal.