This guide will walk you through creating, setting up and installing a Twake application.
You are a manager of the company.
Start by opening your
Applications and connectors, you should see an Installed applications area and Applications developed by the company,
Access your applications and connectors then
Create an application,
Enter your application name and application group.
Application group is used to group your application with other applications of the same type. Be careful, the application group will not be modifiable later.
Let's add a description and an icon for our application. it will be much prettier! 😇
There you will find some important pieces of information:
Your API private key,
Your public application identifier,
URL that will be used to receive events for your application,
List of IP addresses that have the right to call the Twake API with your credentials. (You can use
*during the development of your application.)
Private key and Public application identifier relate to calls to the Twake API.
To configure where your application should display, you need to fill a
JSON object in
Display Settings field.
Here is a quick example, each field is optional and his presence determines the positioning of your application in Twake.
Your application can access and modify data, only according to your needs you don't need to access all the data present in Twake. This is why you must specify the accesses for the proper functioning of your application. These accesses will be public and indicated to the user before the installation of your application.
In our example, we will only add
If you want to know more about capabilities and privileges, take a look at the list here.
Once you've configured your application, you need to install it on Twake.
Applications and connectors, search and display your application then install it.
Your application is now ready, check the Authenticate with Postman documentation for starting using it !