How to Generate an Omnibasis API Client in Any Language Using OpenAPI Code Generators

The Omnibasis API provides a powerful interface for developers to integrate with the platform. As of now, all OpenAPI definitions are hosted under the base URL:

https://api.omnibasis.com 

You must first choose which specific API definition you want to use (e.g., Startup API, Session API, or any other service), and then fetch its respective OpenAPI JSON file.

In this guide, we’ll walk through how to generate an API client for any language using OpenAPI code generators based on your selected API definition.

🛠️ Prerequisites

Before proceeding, ensure you have the following installed or available:

  • Node.js + NPM (if using openapi-generator-cli)
  • Docker (optional)
  • Internet access to fetch the OpenAPI JSON files

✅ Step-by-Step Guide

🔹 Step 1: Choose Your API Definition

All APIs are listed under:

https://api.omnibasis.com 

You need to select a specific definition first. For example:

Service Name
API Path
Startup
https://api.omnibasis.com/startup
Enterprise
https://api.omnibasis.com/enterprise
Explorer
https://api.omnibasis.com/explorer

Navigate to one of these URLs in your browser or via API to see the available documentation and download links for the OpenAPI JSON.

Each service has its own OpenAPI JSON file located at:

https://api.omnibasis.com/<service-name>/api.json 

Examples:

  • Startup API: https://api.omnibasis.com/startup/api.json
  • Enterprise API: https://api.omnibasis.com/enterprise/api.json
  • Explorer API: https://api.omnibasis.com/explorer/api.json

Choose the one that matches the service you're integrating with.

🔹 Step 2: Download the OpenAPI JSON File (Optional)

If desired, save the JSON locally:

bash
curl https://api.omnibasis.com/startup/api.json  > omnibasis-startup-api.json

Replace startup with the name of your chosen service.

🔹 Step 3: Choose Your Target Language

Decide on the programming language you want to generate the client for. Supported languages include:

  • TypeScript
  • Python
  • Java
  • C#
  • Ruby
  • PHP
  • Go
  • Swift
  • Kotlin
  • JavaScript
  • Dart
  • And many more...

See the full list of supported generators here: OpenAPI Generator Supported Languages

🔹 Step 4: Use OpenAPI Generator

There are multiple ways to generate the client. Here are three popular options:

🧱 Option A: Using openapi-generator-cli (Recommended)

Install the CLI Tool

bash
npm install @openapitools/openapi-generator-cli -g

Generate the Client

Use the following command format:

bash
openapi-generator-cli generate \
  -i https://api.omnibasis.com/<service-name>/api.json  \
  -g <language> \
  -o ./omnibasis-client

Replace <service-name> with your chosen API (e.g., startup, enterprise) and <language> with your target programming language.

Example for Python (Startup API):

bash
openapi-generator-cli generate \
  -i https://api.omnibasis.com/startup/api.json  \
  -g python \
  -o ./omnibasis-python-startup-client

Example for TypeScript (Enterprise API):

bash
openapi-generator-cli generate \
  -i https://api.omnibasis.com/enterprise/api.json  \
  -g typescript \
  -o ./omnibasis-ts-enterprise-client

🐳 Option B: Using Docker

If you don’t want to install anything globally, use Docker:

bash
docker run --rm \
  -v ${PWD}:/local openapitools/openapi-generator-cli generate \
  -i https://api.omnibasis.com/<service-name>/api.json  \
  -g <language> \
  -o /local/omnibasis-client

Replace <service-name> and <language> accordingly.

💻 Option C: Online Generators

Use online tools like:

Steps:

  1. Visit one of the online generators.
  2. Paste or upload the specific OpenAPI JSON URL (e.g., https://api.omnibasis.com/startup/api.json).
  3. Select your target language from the dropdown.
  4. Click "Generate" and download the resulting client SDK.

📦 Step 5: Install & Use the Generated Client

Once generated, follow the instructions in the README inside the output folder to install and use the client.

For example, for Python:

bash
cd omnibasis-python-startup-client
pip install -r requirements.txt
python -m pip install -e .

Then, start writing code using the auto-generated classes and methods.

🔐 Authentication

Make sure to handle authentication correctly. The Omnibasis API uses standard mechanisms like API keys or OAuth2 tokens. These will be reflected in the generated code.

Check the /auth endpoints in the OpenAPI spec or refer to the Omnibasis documentation for details.

🔄 Optional: Customize the Generation

You can customize the generation process using additional parameters or a config file. Example:

bash
openapi-generator-cli generate \
  -i https://api.omnibasis.com/startup/api.json  \
  -g python \
  --additional-properties=hideGenerationTimestamp=true,packageName=omnibasis_startup_sdk \
  -o ./omnibasis-python-startup-client

Refer to the OpenAPI Generator Documentation for advanced configuration options.

✅ Summary

Step
Description
1
Navigate tohttps://api.omnibasis.comand choose your service (e.g., startup, enterprise)
2
Get the OpenAPI JSON link for that service:https://api.omnibasis.com/<service-name>/api.json
3
Choose your target language
4
Useopenapi-generator-cli, Docker, or online tools to generate the client
5
Install and integrate the SDK into your project
6
Handle authentication and begin making requests

📚 Resources

📣 Need Help?

If you're having trouble generating the client or integrating the SDK, reach out to the Omnibasis support team or consult the official developer documentation.