Discover APIs

This guide walks you through the features of API Listing, where you can access and interact with published APIs.

As a user of an organization, you have access to view and utilize their published APIs. The API listing section displays all the published APIs, allowing you to try them out, contact the publisher, subscribe, and more. This guide covers all the features of the API listing and provides effective tips for using them.

API Listing Features

• View published APIs across all organizations that you have access to.
• View API details and evaluate them.
• Try out APIs.
• Subscribe to APIs.
• Contact the API publisher.

---

Filter and Bookmark APIs

To filter and bookmark APIs, you can use the following methods:

1. Switch between organizations:
   • Users can view APIs associated with their organizations. They can switch between organizations to access APIs published by each entity. Only published APIs of a specific organization are visible.
2. Bookmarking:
   • Users can bookmark APIs for quick access.
3. Tags:
   • They can use tags to filter and search for APIs based on specific criteria.

API Details

The API details include a section that allows you to evaluate the API and subscribe to it.

• About: This section provides a brief overview of the API, its purpose, and its main features.
• API Documents This section helps you try out the API.
• Pricing: This section provides subscription options.

About

Users can access key information about a selected API in the "About" section, including:

• Readme: This section provides a detailed explanation of the API, its purpose, how to use it, and any other relevant information. For example, it might explain how to authenticate with the API, what data it returns, and any limitations or requirements.

• License: This section specifies the terms under which the API can be used. It might specify whether the API is free to use, whether there are any restrictions on commercial use, and what conditions apply if the API is modified or distributed.

• Reviews: This section includes feedback from users who have used the API. Reviews might cover aspects like ease of use, reliability, performance, and any issues encountered.

API Documents

The API documents provide detailed information about the API, including its endpoints, request parameters, response formats, and more. For instance, if our API has an endpoint to fetch user details, the document would describe this endpoint, explaining what kind of request needs to be sent (GET, POST, etc.), what parameters are required or optional, and what kind of response to expect.

The API documents contain the following details:

• Endpoints: Types of available endpoints.
• Endpoint Path: The specific path or URL for each endpoint.
• Endpoint Description: A description of what each endpoint does.
• Content Type: The format in which the API response is returned, such as application/JSON.
• X-Yappes-Key: An authentication key is required to access the API. You can change the Auth key to know more, see Application.
• X-Accept Version: The version of the API being used.
• Remaining Tryouts: Users can make API calls without a subscription. The API publisher sets the limit on the number of API calls per user.
• API Request Examples: Examples of making API requests using curl, JavaScript, Python, and PHP.

Tryout Operation

The API documents offer an interactive feature that allows you to test the API right within the document itself. It also provides examples of both the request and response headers. Headers often contain important metadata about the request or response, such as the content type, authorization tokens, and more. Understanding these headers can help you effectively use the API and handle potential errors.

• Custom Headers: These are specific headers that are unique to the customer or user making the request. They often contain information like session IDs, user IDs, or other identifiers.

• Query Parameters: These are additional pieces of data that can be passed along with the request to provide more information or control over the response. They are typically appended to the URL of the request.

• Response Schema: This describes the structure of the response that the server sends back. It includes information about the data types, names, and relationships of the various elements in the response.

Some APIs might need authentication to try out their operations. If you come across such cases, it is suggested to get in touch with the publisher to get the required authentication credentials for trying out the API.

Pricing Information

If a subscription plan is available, you can subscribe to the API directly. Otherwise, you have the option to contact the API publisher.

There are three types of subscription plans available on the platform:

• Free
• Freemium
• Paid

If none of the subscription plans are useful to you, you can contact the published API and request to create a custom subscription plan.

The pricing section helps you with the following:

Subscription Plans

If available, the pricing section displays subscription plans associated with the API. Once you select a subscription plan, the process is initiated, and you can view this subscription under "Manage Subscriptions". Here, you can check its status and chat with the API provider.

Contact API Publisher

In the absence of subscription plans, users can directly contact the API publisher for further information.