The following is required for integration:
The API documentation contains detailed instructions, code examples, and other information that helps developers integrate with the service or application. The documentation defines:
Thanks to the API, it becomes possible to integrate various applications, services and systems for exchanging information and performing tasks.
There are several ways to find API documentation:
The API must be well documented so that developers can quickly figure out how to use it. Include a description of the endpoints, methods, parameters, answers, and examples.
The API documentation should contain:
Request:
<req>
<query>John Smith</query>
<count>7</count>
</req>
Answer:
<SuggestResponse>
<suggestions>
<value>Smith John</value>
<unrestricted_value>Smith John</unrestricted_value>
<data>
<surname>Smith</surname>
<name>John</name>
<patronymic/>
<gender>MALE</gender>
</data>
</suggestions>
<suggestions>
<value>Johnson John</value>
<unrestricted_value>Johnson John</unrestricted_value>
<data>
<surname>Johnson</surname>
<name>John</name>
<patronymic/>
<gender>MALE</gender>
</data>
</suggestions>
<suggestions>
<value>John Michael</value>
<unrestricted_value>John Michael</unrestricted_value>
<data>
<surname/>
<name>John</name>
<patronymic>Michael</patronymic>
<gender>MALE</gender>
</data>
</suggestions>
</SuggestResponse>
Request:
{
"query": "John Smith",
"count": 7
}
Answer:
{
"suggestions": [
{
"value": "Smith John",
"unrestricted value": "Smith John",
"data": {
"surname": "Smith",
"name": "John",
"patronymic": null,
"gender": "MALE"
}
},
{
"value": "Johnson John",
"unrestricted value": "Johnson John",
"data": {
"surname": "Johnson",
"name": "John",
"patronymic": null,
"gender": "MALE"
}
}
]
}
When developing the integration of a bot with an external system, it is important to understand what tasks the bot should perform and how it will interact with the system. Below are the key points and questions that will help you understand the essence of integration more deeply in order to properly plan the work of the bot and understand what information to request or provide.
Determine how the bot will interact with external systems. Answer the following questions:
Example:
The bot can request information about customer records and send changes, such as confirmation or cancellation of a visit, to the management system.
Make sure how the external system will initiate interaction with the bot:
Example:
After creating an entry in the system, the bot automatically receives a task to call the client to confirm or cancel the visit.
For successful integration, it is necessary to clearly describe the business processes that the bot must automate. This will help you better understand the integration goals and determine the sequence of actions:
An example of a business process:
Determine if there are special preferences or requirements for the way the two systems are integrated:
For further work, it is required to provide test access /cabinet to work with the API so that we can test all available methods.
For example, a bot can request a list of new messages from the server or update data on the user's side in real time.
For more information about integration via server requests, see the article Request.
For example, in a mobile food ordering app, a bot can help users choose dishes, place orders, or provide recommendations while staying inside your app.
Create an integration service that will serve as an intermediary between your system and the TWIN platform. It will process and format data for the correct transmission of information between the two systems, which will ensure smooth interaction.
Creating full-fledged integration between platforms. If you need full integration of the TWIN platform with another system, contact representatives of this platform to discuss integration possibilities. After that, we will be able to arrange a meeting for further cooperation and development of integration.
If the API documentation is hidden and/or unavailable upon request to technical support, there are two options:
You can find the documentation: