Skip to main content

OpenAPI schema

The whole v2 surface as a machine-readable document, so you can generate a typed client instead of writing one.

eConnect Core v2 — 11.0
OpenAPI 3.0 · 688 operations · 416 schemas · 2.2 MB
Download schema

Versions​

One file per release. A client generated against 11.0 keeps working when 11.1 ships, because 11.1 publishes its own document rather than replacing this one.

ReleaseSchemaOperations
11.0econnect-core-v2-11.0.json688
v2 only

This document covers the v2 API and nothing else — every path in it is under /api/v2, plus the JWKS endpoint that belongs to it. The v1 SOAP services and the older REST surface are deliberately not included: a generated client should contain the API you are meant to build on.

Generate a client​

# TypeScript (openapi-generator)
npx @openapitools/openapi-generator-cli generate \
-i econnect-core-v2-11.0.json \
-g typescript-fetch \
-o ./src/econnect-client

# C# (NSwag)
nswag openapi2csclient \
/input:econnect-core-v2-11.0.json \
/classname:EConnectClient \
/namespace:Acme.EConnect \
/output:EConnectClient.cs

# Python
openapi-generator generate -i econnect-core-v2-11.0.json -g python -o ./econnect_client

# Kiota (multi-language, Microsoft)
kiota generate -l csharp -d econnect-core-v2-11.0.json -c EConnectClient -o ./Generated

The document is large because the product is: 416 schemas across fourteen modules. Most generators let you filter, which is worth doing if you only need one module:

# Only the casino surface
npx @openapitools/openapi-generator-cli generate \
-i econnect-core-v2-11.0.json \
-g typescript-fetch \
--global-property apis=CasinoConnectServicesV2,models \
-o ./src/casino-client

Operation ids are {Service}V2_{Method} — CasinoConnectServicesV2_TitoRecordAdd — so generated method names stay recognisable against the reference pages.

Authentication in a generated client​

The document declares one security scheme, bearerAuth, so generators emit a bearer slot. Fill it with the access token from POST /api/v2/auth/login and refresh it on 401 — see Getting Started.

Reading it from a live server​

On a development build the server serves its own copy, which is the one to use if you are working against a pre-release build:

WhatWhere
Schemahttps://<server>/swagger/v2/swagger.json
Swagger UIhttps://<server>/swagger

Production builds do not map either, by design. The download above is how you get the schema for a released version.