Getting Started

Mashery V3 APIs are RESTful API designed for the API providers to integrate with the Mashery provided services and resources such as packages, plans, and endpoints among others. You can use the Mashery API for the following purpose:

• Migration: Migration of existing API programs to Mashery. For example, you have your own API program. You want to use the features and facilities of Mashery for all your new and existing APIs. You can use the V3 APIs and configure the Mashery API program.

• Integration: Integration of Mashery provided services with external dashboards or other tools and existing sites. For example, you have a website that hosts certain API related content. You want specific Mashery resources data to be displayed on the website then you can integrate your website to Mashery resources using V3 APIs.

• Reporting: Fetch member and application content for customized reporting needs. For example, you have a customized reporting tool that needs services or packages data from Mashery to generate specific reports.

• Workflows: Creating custom workflows. For example, you have an automated workflow to analyze key indicators of business. This workflow is connected to Mashery services using V3 APIs to fetch the input resource data.  

Resources in Mashery:

The Mashery resources are used to configure the API traffic management services and the developer management processes. Resources in Mashery allow administrators and developers to perform Create, Read, Update, and Delete (CRUD) operations. Following are the V3 resources available in Mashery:

• Domains

• Services, Endpoints, and Methods

• Packages and Plans

• Authentication

• Roles

• Schedule maintenance events

• Email template sets

Architecture

A typical API process flow comprises of the following steps:

1. API provider makes a V3 API request to the Mashery services.

2. Mashery services return a V3 API response to the API provider.

3. API provider uses the response for specific requirement: Reporting, Integration with other tools, migrating existing API program to Mashery, and custom workflows.