Introduction to connectors

Overview

ApiShare Connectors are pre-configured integrations that enable seamless synchronization, governance, and automation between ApiShare and external platforms. These connectors facilitate the consistent enforcement of API policies, improve security and compliance, and streamline API lifecycle management across different enterprise systems.

ApiShare offers multiple types of connectors, including:

• API Gateway Connectors: Enable direct integration with API management platforms to ensure that API lifecycle events—such as publishing, versioning, and retirement—are synchronized in real time across enterprise API gateways.

• Identity Provider (IdP) Connectors: Facilitate the management of authentication keys, tokens, and security credentials, ensuring that API access policies comply with corporate identity management frameworks.

• CI/CD and DevOps Connectors: Automate API deployment workflows by integrating with continuous integration and delivery (CI/CD) pipelines, reducing manual operations in API governance. These connectors are implemented ad hoc, considering that the configuration of CI/CD pipelines may vary from Client to Client, ensuring flexibility and adaptability to different DevOps ecosystems.

Supported capabilities

The capabilities of available connectors vary depending on their maturity level and the specific third-party application they integrate with.

API Gateway

Capability	Boomi API Gateway	Red Hat 3Scale	Azure API Gateway	Kong
API Lifecycle
API Subscription
APP Lifecycle
Key Set Lifecycle
Organization Synch

Identity Provider

Capability	Oracle Access Management	Azure Entra Id	Keycloak
Key Set Creation
Key Set Lifecycle
Key Set Retrieve

Deployment Options

ApiShare connectors offer flexible deployment options to accommodate different infrastructure requirements and security policies. Depending on the deployment model of ApiShare and the accessibility of third-party components, connectors can be deployed in one of the following modes:

SaaS Connectors

In a SaaS deployment of ApiShare, connectors are fully managed within the ApiShare cloud environment. These connectors interact with the public APIs of third-party services, ensuring seamless integration, synchronization, and governance without requiring additional deployment within the customer’s infrastructure.

Use Case:

• Best suited for publicly accessible third-party services such as cloud-based API gateways.

• Minimal setup effort, fully managed by ApiShare.

• No need for additional network configurations.

Local Connectors

For on-premises or private cloud deployments of ApiShare, connectors must be deployed within the same environment as ApiShare. This ensures that connectors can securely communicate with third-party systems that are not accessible via public networks.

Use Case:

• Ideal for enterprise systems hosted in private environments.

• Requires manual configuration to enable access to third-party services.

• Ensures compliance with internal security policies.

Hybrid Connectors

In scenarios where ApiShare is deployed as a SaaS solution, but third-party components are located within a private environment, a Hybrid Connector approach is used. This model consists of two components:

• Connector Core: Deployed within the ApiShare cloud.

• Connector Agent: Deployed in the customer’s private environment to interact with third-party services securely.

The Connector Agent is responsible for pulling data from the Connector Core in a scheduled fashion, ensuring secure data synchronization without exposing critical functionalities to the internet.

Use Case:

• Ideal for scenarios where external API gateways or services reside in private networks.

• Ensures controlled data exchange without direct exposure to the internet.

• Provides a balance between cloud-based flexibility and on-premises security.

Choosing the Right Deployment Model

The selection of the appropriate deployment option depends on factors such as API accessibility, network security requirements, and organizational policies. ApiShare’s flexible deployment models ensure seamless integration with third-party platforms, while maintaining strong governance and compliance controls.