Interested in integrating some of our Digital Health APIs in your software? A little confused about where to start, how to do it or what steps to follow? This post is for you (and your IT team). We have prepared this quick guide for the API Consumer in Nubentos thinking of you, walking in your shoes and putting together everything we would like to find if we were you.
Tabla de Contenidos
- 1 FIND YOUR API
- 2 SIGN UP IN THE API STORE
- 3 SUBSCRIBE TO THE API
- 4 TEST THE API
- 5 INTEGRATE THE API IN YOUR SOFTWARE
- 6 MONITOR YOUR SUBSCRIPTIONS TO CONTROL COSTS
- 7 CONCLUSIONS
FIND YOUR API
From our public API Store, click on the API of your interest.
It will take you to some information about the API with a button to Visit Publisher Store.
Click on that button.
TIPS AND INFORMATION
When you click on an API labeled as “SOON”, you won’t find a “Visit Publisher Store” button. Instead, you will see a subscription form. You can use it to be informed by email as soon as that API becomes fully available.
The “SOON” state (“COMING SOON”) means that API is already being published, and will be fully available as a FREE, FREEMIUM or PAID API in the near future.
SIGN UP IN THE API STORE
A new tab will open.
You are now in the API Publisher’s private Store. There you will see all the APIs published by that specific provider.
Here you must sign in as a registered user to get access to all the API information. So, if you have already signed up, you have to sign in now. Otherwise, you have to sign up.
You will find both options in the upper right corner.
TIPS AND INFORMATION
When you sign up, you are registering within the publisher’s private Store. For any other publisher, you will be still a non-registered user.
When you sign in, remember to add “@publisherdomain.com” to your user id.
For example, say you sign up with a user id “myuserid” at Medicsen API Store in Nubentos. When you sign in, you have to type “firstname.lastname@example.org” in the user id field. It’s like saying “I am registered as myuserid at medicsen.com”.
Another important detail you have to keep in mind: when you finish the sign up step and enter your new credentials as explained above, you will be prompted to select the publisher’s store you want to sign in. This means that, if you have signed up in Medicsen Store, you have to select Medicsen.com Store when prompted.
You can choose any other providers Store, but your new credentials will only give you full access to Medicsen’s APIs, listed only in Medicsen.com Store.
For full access to other provider’s APIs, sign up in their private API Store, and use their domain to sign in (email@example.com).
SUBSCRIBE TO THE API
Now you will access all the available information about the API. The API documentation will be helpful to learn how to use the API.
Subscription tiers should be your next stop. Just select the subscription tier that best suits you (many APIs include a free small tier), and subscribe to it.
All subscriptions require to select an Application.
Upon successful subscription, you can choose to stay in the API screen, or go to the subscriptions list in the Application screen.
TIPS AND INFORMATION
In Nubentos API Store, an Application is an entity you must create (or use the default one) to help you manage your subscriptions properly.
Each Application may have as many subscriptions as you wish, and will generate the tokens you need to use to send requests to the corresponding APIs.
Each Application manages its own tokens. You can set the tokens expiration time, after which you should send a renewal request.
From each Application detail, you can see their active subscriptions and unsubscribe in case you need to move it to another Application or you have decided not to use it anymore.
You may be wondering why you should need more than one Application?
Using different Applications can be useful in certain cases. Let’s see a couple of them.
DIFFERENT CLIENTS SEGMENTS
For example, say you have different clients in size. You have one big client and one small client. It makes sense that the big client will have more users and can afford more costs. And the small one will have less users and less budget.
The API you want to integrate in your software, offers two subscription tiers: a small one, up to 1.000 requests per month and a fee of 0,02€ per request, and a big one, up to 10.000 request per month, and a fee of 0,04€ per request.
To optimize your development costs, you would like to use the small plan for your small client, and the big plan for your big client.
You can do this by creating two Applications.
Then you can subscribe to the big plan in one Application, and to the small plan in the other one.
The Application that holds your subscription to the big plan, will manage the tokens to be used in your code for your big client (in a specific version of your product, for example).
And the other Application holding your subscription to the small plan, will manage the tokens that you will use in your code for your small client (in a separate version of your product, or having the tokens parametrized).
This way your costs will be calculated separately, although they will come from the same software product. For each subscription, their specific costs will apply.
This way you can optimize your costs and adjust them to the different clients you may have for your software.
DIFFERENT SOFTWARE PRODUCTS
Another good reason to use different Applications is to help you monitor your users, how they use your APIs, and have a more granular vision to take better management decisions based on their behavior and about your development costs.
For example, say you have two different software products, and you want to integrate the same API in both of them.
You can create two Applications in Nubentos API Store, and subscribe to the same API in each Application (even to the same subscription plan if it suits both business cases).
You will need to use different tokens in each software product.
By doing this, when you use your analytics dashboard within Nubentos API Store, you will be shown the analytics for each Application separately, instead of all together.
The information you will see will match the real usage of each software, made by the end users of each product.
You will be able to better understand how each product’s end users are using your API, and manage your development costs more properly.
TEST THE API
The first time you subscribe to an API, you need to generate the tokens to be used in your requests. This is true just in case this is your first subscription in the selected Application, because tokens are generated and managed within Applications and apply to all its subscriptions.
If this is your case, you must go to the Application screen, and generate the keys in the tab corresponding to the environment you want to send your requests to.
When you are using your API for the first times, you will want to test it against the Sandbox environment. Otherwise it may generate costs for you, provided that you have subscribed to a paid tier.
Therefore, our suggestion is to generate only the token for Sandbox environment.
Notice that this action has also generated the Consumer Key and the Consumer secret.
You can also establish the expiration time for the token in this environment, expressed in seconds (60 minutes by default, negative value if you want your token to never expire).
Once you have your tokens generated from the Application that holds your subscription, you can use them in the Integrated Test Console.
Pay attention to select the Sandbox environment before sending any test. The generated token for that environment will automatically appear in the “Set Request Header” field.
Just click on its tab in the API detail, and you will be able to test each resource (method), providing the input parameters and checking the response returned after clicking the “Try it out!” button.
TIPS AND INFORMATION
You can test your API as much as you want, but pay attention to always use the Sandbox token.
Notice that no test will generate you costs, regardless of the subscription tier you are subscribed to as long as you use the Sandbox environment.
This means that, although you subscribed to a paid tier, it won’t generate you costs until you use the Production token (and environment).
Of course if your subscription tier is free, it will be free both in the sandbox and in production environment.
INTEGRATE THE API IN YOUR SOFTWARE
When you finish testing your API and have a clear picture of how you are going to use it in your software, click on the SDK tab in the API detail, and download the SDK corresponding to your development technology.
TIPS AND INFORMATION
We have published a specific post to help you integrate your API in your software using the SDK you have downloaded. We encourage you to read it here.
MONITOR YOUR SUBSCRIPTIONS TO CONTROL COSTS
Once your software with the API integrated is deployed to your end users, and they start using it, each use will generate costs for you (provided that you subscribed to a paid tier).
In case you subscribed to a subscription tier with a flat quota, then the platform will keep track of every use to apply the right fee at the end of each month.
You can monitor the use made of your API subscriptions by your end users, through the Analytics you have at your disposal in Nubentos API Store.
TIPS AND INFORMATION
This will be helpful to keep control of possible misuses that could turn into over costs for you, or to monitor if your estimated use level when you chose the subscription tier you subscribed to was correct.
In case you see that there are too many throttled requests, which means that the real usage of your software implies more requests than expected, you can consider to upgrade to a higher plan in order to enlarge your consumption threshold, improve your users experience (preventing from rejected requests) or avoid fees per extra requests.
Of course the opposite situation can also be checked, and you can find it appropriate to change to a smaller plan if you see that your estimations were too high.
In this post, we have walked through the main steps you need to follow to successfully integrate in your software the Digital Health solution provided through an API published in Nubentos API Store.
We have also shown how you can use different Applications for certain situations, to help you take better management decisions and keep your development costs under control.
We have seen how easy it is to test your API before writing any code.
Finally, we have seen that each API published in Nubentos has 10 different SDK available for you. Just pick the one that matches your development technology, and you will have all the technical resources you need to implement the requests to and manage the responses from your new API.
The bottom line is, that using Nubentos API Store to integrate Digital Health solutions gives you more than the solution itself. It gives you the necessary tools to do it under optimal costs, and to help you take the best management decisions about how your end users use the solution through your software products.