Overview

_images/Tech.png

API Setu: Flow

API Setu acts as a unified API marketplace, enabling seamless integration between API publishers and consumers. The platform streamlines the discovery, subscription, and consumption of APIs while ensuring secure data access and efficient service delivery.

1. Publisher Registration & API Publishing

  • A publishers registers on API Setu to publish APIs

  • The publishers are categorized into one of three types:

    a. Document APIs: Handle user specific data, such as PAN, Academic certficates, and income records. Example: DigiLocker APIs.

    b. Service APIs: Provide non-user-specific data, such as Organization PAN, GSTN verification, myScheme, LokOS, etc.

    c. Listing APIs: Enable API partners to list their APIs for use by integrators or for informational purposes. Example: CoWIN APIs.

  • The published APIs are listed on the API Setu marketplace, available for discovery by consumers.

2. Consumer Registration & API Subscription

  • A consumer registers on API Setu to discover and subscribe to APIs.

  • Consumers are classified into two types:

    a. Authorized Partners: Partners who use MeriPehchaan (NSSO) service via DigiLocker Document Service to access user data securely with their consent. Example: Government agencies validating identity documents.

    b. Offline Consumers: Consumers who directly consume Document or Service APIs on API Setu without relying on intermediary platforms. Example: Private enterprises verifying GSTN or PAN details for vendor onboarding.

Consumers browse the API marketplace, discover relevant APIs, and subscribe based on their needs, with access granted only after the publisher’s approval.

Logging is enabled at various service points throughout the API flow to capture essential data on API hits. This data is utilized for generating alerts, monitoring performance, tracking usage statistics, and dashboards, ensuring efficient system monitoring and proactive issue resolution.

Summary

API Setu serves as a bridge between publishers and consumers, enabling efficient data exchange while maintaining security and compliance. Publishers can categorize and share their APIs, while consumers can easily discover and integrate APIs into their applications, streamlining workflows and enhancing service delivery.