NextGen APIs
NextGen APIs
Breadcrumbs

NextGen APIs - APIs Overview

This document provides a high-level overview of the four primary API types utilized within the OverIT NextGen Platform ecosystem. It defines their purpose, target audience, and architectural role.

Architecture diagram

The following diagram illustrates how the different API types interact with internal platform components and external systems.

image-20260518-103505.png

API Type Definitions

Private APIs

  • Scope: Internal

  • Target audience: OverIT NextGen Platform only.

  • Description: Private APIs are the core foundational APIs of the NextGen Platform. They are strictly designed to be used inside the platform for internal, intra-application communication (e.g., communication between FSM, GEO, Field Collaboration, etc.).

They are currently exposed to Internet but this access will be removed in the future!

Integration APIs

  • Scope: External (Internet-Facing)

  • Target audience: External Systems (ERPs, CRMs, Middleware(s)).

  • Description: Integration APIs are the internet-facing APIs explicitly designed for connecting with external systems. They act as orchestrators of the underlying Private APIs, combining multiple internal calls into a single, cohesive business transaction. These are the primary endpoints used to integrate the NextGen Platform with enterprise systems such as SAP or middlewares like SAP BTP, Tibco, and MuleSoft.

Async APIs

  • Scope: Internal (with external publishing/subscribing capabilities)

  • Target audience: Internal Platform & External Event Providers.

  • Description: Similar to Private APIs, Async APIs are primarily meant for internal platform use. They rely on asynchronous events published on event streaming providers (utilizing AWS SNS/SQS in a Fan-Out pattern).

    • Extensibility: While internal by default, we can publish our Async APIs to external event streaming providers if an external system needs to consume our events. Conversely, our platform can subscribe to external event streaming providers to listen for and react to external events.

Public APIs

  • Scope: External

  • Target Audience: Partners and External Developers.

  • Description: Currently in the early-PoC (Proof of Concept) phase. In the future, Public APIs will be the designated interfaces for partners and external developers to build custom applications, plugins, or add-ons that extend the capabilities of the OverIT NextGen Platform.