Adding your API on Zyla API Hub

Created by Zyla Labs, Modified on Fri, 14 Oct 2022 at 02:10 PM by Zyla Labs

First, we must understand the difference between a Developer and an API provider.

The Developer is the one who uses the APIs and implements them for example in a web application.

On the other side, the API provider is who publishes its API so that developers can use them.

Having understood this, let's see how to Publish APIs on Zyla API Hub.

To start publishing APIs, we need to register in Zyla API Hub.


There are 2 options for signing up, you can fill in the registration form or sign up with your Git Hub account.

After you sign up, a verification email will be sent to your email address. 


If you do not receive the confirmation email, you can contact us at and we will be happy to assist you.

Having confirmed our email address, we are ready to publish our first API.

The name and a short description of the API will be required first.

It is very important that you choose a good name for your API that describes in a few words what your API does. We also recommend that the name contain the word "API". For example, if you are publishing an API where customers can get the rates of different metals, we recommend using: “Metals Rates API”.

The short description is also very important. It’s useful to explain in some words the scope of your API, for example: “Metals Rates API is a simple and lightweight API for current and historical precious metals rates. You can get the value between more than 100 metals”

Both the title and the short description are key for your API to get a good position itself in Google searches and get more organic traffic.

The following step is to write a long description for our API.

It is important to include the following information in our long description for the API to be highlighted and noticeable.

About the API:

What this API receives and what your API provides (input/output)?

What are the most common use cases of this API?

Are there any limitations with your plans?

Then, after having completed the long description, we proceed to choose a category, include a link to the website, and choose an icon for our API (Recommended image size: 500x500 JPEG/PNG/GIF/JPG). (Including a website and choosing an icon are optional, but we recommend filling in all the information.)

Now it is time to analyze and choose the plans and pricing of them. You must also select the number of requests (per interval).

Before deciding your prices, we recommend you make a benchmark of your API’s category.

A Tip: A very cheap API, no matter how good it is, generates mistrust. We recommend that you be at market price,

It is important to point out that at least a free plan and a basic plan must be available.

This is the list of prices available to assign to the plans.

Having selected the plans and their prices, you will have the option to add tags to your API. (is optional, but highly recommended to rank the API correctly).

Also, you can enable Rate Limits (optional): 

Rate limits can be defined by a specified number of calls per day, week, month, or year. Rate limits can be "hard" (enforced) or "soft". If the rate limit is "hard" and a call exceeds the limit, then the call is aborted and an error is returned. Set a hard limit by selecting "hard limit" below. 

Or activate Hard Limit:

Overage API calls (if Soft limit is enabled) Plans allow a fixed number of API calls for each interval, but if you enable "soft limits" you could charge an overage fee if the developer exceeds the number of calls of the period. We will use the price per API call of the higher plan for the overage fee.


When finished, select save and we will continue with our API publishing in ZYLA API Hub. Only a few details remain.

The next section we will come across is Add New Endpoint, here it is necessary to choose the name of the endpoint and describe what this endpoint does.

What parameters the endpoint has, which it receives and which it returns. Guidelines to help understand how the endpoint works.

It will be optional to add an external link to more information related to the endpoint.

What's next, would the Access Control - Authentication. 

You must include the name, the value, select a type (Header or Parameter) and create a description.

Zyla implements a single secret key per developer application across all APIs to minimize friction in testing and implementing APIs. Secret request headers and parameters will be transparently added to every request made by a client.

Now in the final steps, it remains for us to declare the base URL from the endpoint. We must specify what type of method it is (GET,POST,PUT,DELETE or PATCH), and indicate how often should our cache be cleared for this endpoint.

If you need to insert a parameter in the URL, please use URL Variables to give developers the ability to pass data in the URL. For e.g. if you want to use "DATA" as a parameter you should use||DATA||/latest .

Below you will have the option to add additional parameters (If the parameter value is empty, will be an input value provided by the user.) and headers.

If you require parameters for the body, you can enter a JSON.

And in the end, you can Manage Response Transformations, by adding New Transformations and replacing the value. Here it is possible to add and delete transformations. Everything is ready for us to publish the API in ZYLA API HUB, just press the button Save & Run!

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article