Documentation

Learn to build and manage your APIs with ease

OxyNexus API Manager is a complete platform for building, integrating, and exposing your digital services as managed APIs in the cloud, on-premise, and hybrid architectures to drive your digital transformation strategy.

It allows API developers to design, publish, and manage the lifecycle of APIs and API product managers to create API products from one or more APIs.

Quick Start Guide

Design and implement APIs

Create, publish, and consume an API in 5 minutes. Let's get started by running a simple use case.

Overview

Introduces OxyNexus API Manager and quickly describes what it can do.

Read a Short Overview

Concepts

The key concepts of OxyNexus API Manager give you a brief introduction to the terminology and make it easy for you to understand the API management domain.

Understand the Concepts

Architecture

The OxyNexus API Manager consists of a management plane, a data plane, and a control plane, along with multiple developer-friendly tools to help you work with the various components.

View Architecture

APIM Scenarios

Create REST API from an OpenAPI Definition

Create an API in OxyNexus API Manager that maps to an OpenAPI definition.

Engage Access Control to the API

Configure your API so that it is visible only to selected users.

Implementing an API

You can implement the business logic to call three backends that provide metrics, aggregate the response, and present it to the client as one response.

Signing up a New User

OxyNexus API Manager provides extension points to trigger workflow tasks for many operations such as Application creation, subscription creation, user signup, etc.

Getting the Developer Community Involved

OxyNexus API Manager Developer Portal provides many features to assist developers to use the APIs published.

Integrating with Data Sources

When you create a data service in OxyNexus Micro Integrator, the data that is stored in a storage system (such as the RDBMS) can be exposed in the form of a service.

Analytics

Choreo API Manager Analytics can be used to fulfil the stats and analytics needs of the API Manager.

Rate limiting

OxyNexus API Manager provides various levels of rate limiting to control the number of transactions at any given time.

Realtime Data with WebSocket API

OxyNexus Streaming Integrator (SI) is a streaming data processing server that integrates realtime streaming data and takes action based on the streaming data.

Notifications Using WebHooks

The API Manager enables you to provide information as webhooks so that companies can subscribe to these notifications without continuously polling.

GraphQL Support

OxyNexus API Manager supports creating GraphQL APIs using the GraphQL schema.

Guaranteed Message Delivery

Store and forward messaging pattern is used to ensure guaranteed delivery of messages. Messages never get lost since they are stored in the message store.

Integrate with Services via Connectors

When you integrate systems in your organization, it is also necessary to integrate with third-party systems to enhance your services. This is possible via Connectors.

External Key Manager Support

OxyNexus API Manager comes with external key manager connectors to various identity providers such as Okta, Auth0, Keycloak, etc. Additionally, you can write a custom Key Manager implementation.

Other

Look through the available tutorials for more product capabilities.

Deployment

See the instructions on setting up the API-M runtime for your selected deployment pattern.