Learn How to Use Sirena's New API Documentation
Now you can add your personalized apps to Sirena's API. Get to know our new documentation and the valuable content it has to offer.
Not long ago, we announced the launch of our new App Marketplace, where we told you you can find integrations for the various programs and applications you use every day in your work.
But you will also be able to create your own integrations and even developers from other companies will be able to develop applications.
For all this, it's important that you read about the documentation we have launched.
Why did we launch the new Sirena API documentation?
In order to facilitate and fine-tune the development of these applications, the documentation offers tools, instructions, and all the complementary information for the development of your apps.
The documentation available up to this point was not sufficiently detailed to allow developers to fully understand the Sirena API.
With the new update to the documentation, developers will be able to find more information about what is involved in creating your own app for the Sirena API, what the benefist are, and what the difference is between creating your own app vs. simply connecting via the API.
In addition, we suggest useful tools from Sirena to boost development of these applications.
To add the new documentation in a way that would be accessible to everyone, we have added a new Help Center section on the Sirena site.
Who is this documentation for?
This tool is primarily directed at developers (they do not need to be Sirena clients) who want to produce a solution that integrates the Sirena platform with any other platform (Mercadopago, Hubspot, Stripe, Hotjar, or whatever you can come up with).
However, the documentation was created to allow anyone who wants to learn more about Sirena applications to read more about them. To make sure the technical language is easy to understand, we have developed a glossary to refer to if you have any questions about any of the terminology.
What sections does the new Sirena documentation include?
Briefly, the documentation is structured as follows:
- Getting started with Apps
- Apps section
- How to build your own App
- App Developer Resources
- HOW TOs
Getting started with Apps
This is the first section in the Help Center. You should start your reading with this section, where you'll find the most relevant terms to keep in mind for development and/or to understand how the marketplace works.
According to your goals, from there you can proceed to one of two sections:
- If you are interested in more information about apps and what they are, go to the Apps section
- If you are planning to build your own app to integrate with Sirena, go to the How to Build Your Own App section, which discusses the benefits of connecting your own app and will provide the link to go to Sirena's tool box (API, extension points).
In this section, you can learn how to find and install new applications, check the status of your installed applications, configure them, and even uninstall them if you are no longer using them.
All types of users can access this section.
How to build your own App
You'll find the most common reasons integrations are developed (sync CRMS, personalize reports, personalized conversation triggers, among others).
From here you can proceed to the tools and resources section.
App Developers Resources
Here you'll see information about extension points, reports, buttons, and prospect and user fields.
We included some small sections about how to execute certain actions: how to get the API key, how to create your App Manifest, how to make your integration public, how to import endpoints, and information to subscribe to Webhooks.
What do I need to do if I want to integrate an app with Sirena?
Basically, to integrate an app with Sirena, once you have developed your app, create an App Manifest for it (this is a document taht contains all the information about your app, such as official name, logo, extension points used, what API scope it corresponds to, etc.)
Create your App Manifest simply and easily by completing this form in our How To section.
If you want to make your app public, can complete an additional form that you'll find in the same section. In this case, you'll be asked a few additional details, such as the app URL, what version it is, etc.
Once you have sent us all the pertinent app documentation, our team of developers will review it and verify that everything is in order and that the integration works with the Sirena platform. When your app is approved it will appear on the Sirena marketplace.
For the moment, the documentation is only available in English, but we will soon be sharing it in other languages as well!
Go to the Help Center to start incorporating tools to create your own integrations.