Skip to content

Manage Subscriptions

This guide walks you through the features of "Manage Subscriptions", where you can view all your API subscriptions at individual and group levels, and chat with the API publisher.

The Manage subscription feature tracks organization-level APIs and individual API subscriptions. With this feature, you can view subscription plan details, filter subscriptions, select API environment, copy/reset keys, view sample requests, and download API documents.

Manage Subscription features

  • View your API subscription details.
  • Select API Environment.
  • Rate and provide feedback on APIs.
  • Access public and private API keys.
  • Download API documentation.

Manage Subscriptions features

Manage subscription

  • View Subscription Plan Details: Each subscription will have a link to view the details of the subscription plan. This includes information such as the cost, duration, keys, etc., included in the plan.

  • Filter Subscriptions: You can filter your subscriptions based on individual and group APIs and organizations. This makes it easier to manage your subscriptions and find the ones you're interested in.

API Providers

Under Manage APIs, you can view the APIs that you have subscribed to, along with APIs provided at an organizational level.

Default APIs: You may see APIs that are available to you even if you have not subscribed to them from the marketplace. These APIs are provided at an organizational level, allowing all members of the organization to consume them.

API Subscriptions: These are APIs that you have subscribed to from the marketplace.

Organizational level APIs

Select API Environment

The API publisher has the option to grant access to environments other than production. However, this is only available to internal users who are involved in the development or testing of the APIs. In such cases, you may be given access to those environments.

details

Rate APIs

You can provide feedback regarding the API to the API publisher as well as other users using the Rate feature. It lets you rate the APIs out of 5 stars and also add your comments, as shown in the gif below.

Add review

Manage Keys, Samples, & Endpoints

  • Private key and public key: You can copy the public and private keys for each subscription. If necessary, you can also reset the keys.

  • View sample request: Each subscription will have a link to view a sample request. This can help you understand how to make requests to the API.

  • Select APIs & Endpoints: If the subscription has multiple APIs or Endpoints then you can switch between them from here.

key and sample

  • API Documentation JSON: You can download the API documentation for each subscription. This documentation will provide detailed information about the API, including its endpoints, request parameters, response formats, and more.

You can see a sample API documentation JSON below:

{
 "apiName": "dell",
 "apiDefinition": {
   "info": {
     "title": "dell",
     "description": "Test",
     "version": "0.0.0",
     "termsOfService": "asdfg",
     "contact": {
       "email": ""
     },
     "license": {
       "name": "dell",
       "url": "https://yappes.com/"
     }
   },
   "schemes": [
     "https"
   ],
   "basePath": "/",
   "definitions": {
     "result": {
       "type": "object",
       "default": "{ \"key\" : \"value\"}",
       "properties": {
         "key": {
           "type": "string"
         }
       }
     }
   },
   "tags": [
     {
       "name": "john"
     }
   ],
   "paths": {
     "/post": {
       "get": {
         "description": "test",
         "consumes": [
           "application/json"
         ],
         "produces": [
           "application/json"
         ],
         "parameters": "",
         "responses": {
           "200": {
             "description": "successful operation",
             "schema": {
               "$ref": "#/definitions/result"
             }
           }
         },
         "security": [
           {
             "yappes-auth-key": [],
             "yappes-subscription-key": []
           }
         ]
       }
     }
   },
   "host": "yappes-enterprise.com",
   "swagger": "2.0",
   "externalDocs": {
     "description": "",
     "url": "https://yappes-enterprise.com"
   },
   "security": [
     {
       "yappes-auth-key": [],
       "yappes-subscription-key": []
     }
   ],
   "securityDefinitions": {
     "yappes-auth-key": {
       "type": "apiKey",
       "name": "x-yappes-key",
       "in": "header"
     },
     "yappes-subscription-key": {
       "type": "apiKey",
       "name": "x-yappes-subkey",
       "in": "header"
     }
   }
 }
}