FAQs API Publisher
I want to publish my APIs in the Nubentos API Marketplace, but how will I do it?
In Nubentos we want to guarantee to the entire health ecosystem that the APIs that we publish contribute a high added value to the sector and solve or help solve business cases of interest for the Connected Health business processes.
Our platform for the publication of APIs in Health is not open to the public. We invite companies to publish their APIs in our Marketplace. Alternatively, if you have not been contacted by us, and you want to publish your APIs in Nubentos, you must follow these steps:
- Contact Nubentos to request to be our customer. You must use the contact form published on our website to request new clients. From this moment our relationship is subject to our Terms and Conditions of use, which includes a strict non-disclosure clause.
- Provide us with the information that we will request about the API / s you wish to publish and the business case (s) involved.
- We will study your request and the information provided, and in case of matching our publication criteria, we will contact you to confirm your incorporation to our API Markeplace as an API provider. From here, we will start working together to have your APIs published as soon as possible.
I received your ok and I am already a customer, where do we start?
The first thing we will do is prepare a section in the Nubentos API Marketplace to publish your APIs. You can visualize it as if in a department store we prepared an exclusive area for your products.
In fact our API Marketplace works in a similar way to a department store. All APIs are published in a public Store, which serves as a showcase. Anyone who visits our public Store anonymously can see the published APIs, as if a passerby stopped in the windows of a department store.
In order to “acquire” one of your APIs, the anonymous visitor must register and identify himself in the specific section prepared for your APIs. He/she will also have your contact information in case he/she needs to clarify doubts or expand the information published in your APIs before deciding to subscribe and incorporate them into their software products.
The preparation of your section in the Nubentos API Marketplace requires a few data that you will need to provide, and within 48 hours you will have access to publish your APIs.
What accesses will I have?
By default, we prepare two levels of credentials for our clients:
- API Creator. Oriented to a technical profile, this user will have the necessary permissions to create and configure the APIs, but not to manage its life cycle.
- API Publisher. Oriented to a consultant or business profile, this user will have the same permissions as the previous level, and also the necessary permissions to manage the life cycle of the APIs.
This separation of roles aims to grant you a level of security and control for the governance of your APIs, preventing a certain profile from making changes for which it is not authorized.
If you have different requirements regarding access credentials and permissions, please contact us and we will analyze your case.
We do not provide administration permissions to our clients. All administration tasks are performed exclusively by Nubentos, both in the global API Marketplace and in each of our clients areas.
I already have my access credentials, what is the next step?
Before creating your APIs, you must set up your pricing plans. When you publish your API, you will be able to select which plan should be published. And optionally, you can set traffic limitation policies (throttling policies).
In order to register the price plans that you want to offer to the subscribers of your APIs, you must provide us with the details of those plans. For each plan that you want to register, you must establish:
- Plan Name. Some examples: Gold, Silver, Bronze, Plus, Standard, Basic, Premium, etc., etc.
- Plan Description. This is the description that the subscriber will see when selecting the level of consumption to which he/she subscribes. Some examples:
- Plan to use 1,000 requests per minute, with a monthly flat fee of € 90, and an extra fee of € 0.02 per request.
- Plan to use 50,000 requests per hour, at 0.05 euros each request. In this case, requests above the established level are not allowed, so there is no fee indicated for extra request.
- Free use plan up to 1,000 requests per day, no fee for extra request.
- Bursts control. Along with the consumption stretch you set for the plan, you can set a traffic burst limit per second. This parameter can protect you from improper use of your API.
- Blocking upon the traffic limit. You can decide that requests that exceed the level of consumption of your plan are rejected, or that they are accepted for, for example, applying a special rate. Unless you set a special rate for extra requests, it is most reasonable to activate this block.
You can define as many subscription plans as you wish, since when you set up each new API you can choose which plans are offered to the possible subscribers that access the API published in the Store.
When you exclusively offer free use plans, your API will be published as FREE. When you offer both free use plans and commercial use plans (with a fee), your API will be published as FREEMIUM. When you exclusively offer commercial use plans, your API will be published as PAID.
Of course, you can request new plans at any time, as well as the throttling policies that you consider convenient.
How do I publish my APIs?
To publish your APIs in Nubentos, you have complete guides in the online documentation of our technological provider, depending on the technology of your APIs:
*** VERY IMPORTANT ***: In all cases, you must also take into account some specific details of the Nubentos API Marketplace that you must follow to guarantee the maximum visibility of your APIs and an adequate user experience to the visitor of your API Store:
- Your APIs must have Public visibility. In the “Design” tab of the creation of a new API, you must always set the “Visibility” field as “Public”.
- Tags (Tags) reported correctly. In the “Design” tab of the creation of an API, you must provide the tag / s that allow to discover your API in a coherent way. We periodically review the tags of the published APIs to maintain a homogeneous set of labels that helps the prospective subscriber find them easily.
- The subscription to your APIs should be allowed only to users of your organization. In the “Manage” tab of the creation of an API, in the “Subscriptions” field you must always select “Available to current tenant only”.
- You must provide your contact information. In the “Manage” tab of the creation of an API, the “Business Information” section allows you to provide the contact information of the functional or business manager of the API, and the technical manager of the API. You must provide both contacts.
- You must confirm the display of your API in the Nubentos Public API Store. When your API is published, and only then, you will have available in the API a new tab to confirm the visualization of your API in the Nubentos Public API Store. You must check the box of the Nubentos Public API Store and save. If you do not perform this action, your API will be published in your section but not in the public API Catalogue, thus loosing visibility.
How can I document my APIs?
To document your APIs, you must first have created them. From the “Docs” tab of the API you can add documents to your API that will be available to your visitors based on the visibility level you assign to them.
The first level of documentation, to which you must pay special attention, is the API description. This text will be visible in the tab of your API in the Nubenos Public Store, and therefore it will be the first and only information that an anonymous visitor of the Catalog will see. It is very important that the description of your API clearly and concisely show what it is and the value it brings.
There are different ways to document your APIs in the Nubentos API Marketplace:
- You can upload files from your systems to be downloaded from Nubentos by your APIs subscribers.
- You can link documents through your URL to be consulted directly on your servers or in your document manager.
- You can create and edit directly with the online editor included in Nubentos.
For each document, you can set visibility level among the following:
- Same visibility as the API (“Same as API visibility”), so it would be public and available to any user who visits your section in the Store API of Nubentos, no need to register as a user or subscribe to the API.
- Visible only to your section (“Visible to my Domain”), so it would be visible only to registered users in your section of the Store, even if they have not subscribed to the API.
- Private (“Private”), being only visible to users of your section with permission to create, edit and modify APIs (usually users of your organization). This level makes the document not available to visitors or subscribers. It is therefore appropriate for internal documentation, or for documentation that is not yet finished, for example.
How can I manage the life cycle of my APIs?
When you start using the Nubentos API Publisher, we provide a user with permissions to manage the Life Cycle of your APIs, which implies actions such as publishing a created API (“publish”), declaring an obsolete API (“deprecate”) and retire APIs (“retire”).
To do this, in the “Lifecycle” tab of the API you can make the state transitions that you want according to the Life Cycle that is shown in the viewer. You also have all the history of states through which your API has passed.
How do I monitor the use of my APIs?
Nubentos incorporates tools for monitoring and analytics of the APIs usage, with which you can analyze the behavior of your subscribers, the performance of your APIs, and other data of interest.
To access all this information, you have the option “Analytics” from the left side menu.
How can I bill the subscribers of my APIs?
On a monthly basis, we will send you a detailed report with:
- the use that your APIs have had from each subscriber,
- the subscription plan to which each subscriber of each API has subscribed,
- the amount to be invoiced to each subscriber, resulting from applying the plan subscribed to the traffic received.
With this information and the subscriber’s contact information you can generate your invoices.