Skip to content

README and License

The Yappes API Manager lets you add README and license details for your API(s) when you onboard it. These details allow the provider to define APIs usage and ownership.

The README file contains information about the API’s functionality, how to use it, any dependencies or requirements, and examples of API requests and responses.

The license file allows you to define the terms and conditions under which the API can be used. It specifies the rights and restrictions imposed on the users of the API, ensuring compliance with legal and intellectual property considerations.

Including both a README file and a license file helps establish clarity, transparency, and proper usage guidelines for the API.

If you need to add/edit the README or license details of the onboarded API, follow the below steps:

Note

The following steps require platform-admin, api-product-manager or api-developer user role.

  • Access Manage APIs → My APIs

Accessing My APIs

  • Click for the API you need to add README and/or License.

Info

If the API is published, unpublish it first, then follow the below steps. Visit, Unpublish API.

  • Scroll to the bottom, then:
    • Add details for the Read Me
    • Then, for the License

Added README and License Details

The README and license info could be like the following:

README Example

API Name: Customer Management API
Version: 1.0.0

Overview

The Customer Management API enables organizations to manage customer data securely and efficiently.
It provides a full set of operations to create, update, retrieve, and deactivate customer records.

Base URL

https://api.yappes-enterprise.com/v1/customers

Features

  • Create and update customer records.
  • Retrieve customer information by ID or email.
  • Manage customer status (active/inactive).
  • Integrates with third-party CRM and billing systems.

Request and Response Format

  • Request Format: JSON
  • Response Format: JSON
  • Authentication: Yappes subscription key and auth key headers
    x-yappes-key: <your-auth-key>
x-yappes-subkey: <your-subscription-key>

Example Request

curl -X GET "https://api.yappes-enterprise.com/v1/customers?email=john@example.com" \
  -H "x-yappes-key: your-auth-key" \
  -H "x-yappes-subkey: your-subscription-key"

Example Response

{
  "customerId": "CUST001245",
  "name": "John Doe",
  "email": "john@example.com",
  "status": "active"
}

License Example

License Name: Enterprise Customer Management License
License Type: Proprietary (Internal Use Only)

License Description:
This API is licensed for enterprise subscribers only. Authorized users are granted access to use, modify, and integrate this service solely within their organization’s internal infrastructure.
Redistribution or public exposure of the API without written permission from Yappes Enterprise is strictly prohibited.

  • Once added the details, click Save.

The added README and license details will be accessed by the user in the API Listing.