Skip to content

My Subscriptions

This guide walks you through the features of My Subscriptions, where you can manage your active API subscriptions.

My subscription allows you to manage your active API subscriptions. You can view plan details, filter subscriptions by individual and group APIs and organizations, select API environment, copy/reset keys, access sample requests, and download API documents.

My 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.

Subscription Details

My subscriptions

  • View Subscription Plan Details: You can view the details of each subscription plan. This includes information such as the cost, duration, API keys, environments, etc.

  • 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.4

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 give feedback for the APIs that are available to you. This lets you share your thoughts, opinions, and suggestions to make the APIs better and improve the user experience.

Add review

Copy API Keys

You can copy the public and private keys for each subscription.

key

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. If the API Subscription has multiple endpoints or APIs, then you can switch between them.

key

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": "assdfg",
      "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"
      }
    }
  }
}