WSO2 API Manager is a complete solution for publishing APIs, creating and managing a developer community and for routing API traffic in a scalable manner. It leverages the integration, security and governance components from the WSO2 Enterprise Service Bus, WSO2 Identity Server, and WSO2 Governance Registry. In addition, as it is powered by the WSO2 Business Activity Monitor (BAM), the WSO2 API Manager is ready for massively scalable deployment immediately.
This guide walks you thorough the main usecases of the API Manager:
|Table of Contents|
Introduction and concepts
Let's take a look at the basic concepts that you need to know before using the API Manager.
The API manager comprises the following components:
- API Gateway : Secures, protects, manages, and scales API calls. It is a simple API proxy that intercepts API requests and applies policies such as throttling and security checks. It is also instrumental in gathering API usage statistics.
- API Key Manager : Handles all security and key-related operations. API gateway connects with the key manager to check the validity of OAuth tokens when APIs are invoked . Key Manager also provides a token API to generate Oauth tokens that can be accessed via the Gateway.
- API Publisher : Enables API providers to publish APIs, share documentation, provision API keys, and gather feedback on API features, quality and usage.
- API Store : Enables API consumers to self register, discover API functionality, subscribe to APIs, evaluate them and interact with API publishers.
Additionally, statistics are provided by the monitoring component, which integrates with WSO2 BAM.
Users and roles
The API manager offers three distinct community roles:
: a creator will typically be a person in a technical role who under
stands the technical aspects of the API (interfaces, documentation, versions,
how it will be exposed by API gateway) and uses the API publisher web appli
cation to provision APIs into the API store. The creator will use the API store
to consult ratings and feedback provided by API users. Creator can add APIs
to the store but cannot manage their lifecycle (i.e. make them visible to the
: the publisher typically manages a set of APIs across the enter
prise or business unit and controls the API lifecycle and monetization aspects.
The publisher is also interested in usage patterns for APIs and as such has ac
cess to all API statistics.