¶ JOIN Rest API
Jump to navigation Jump to search
JOIN Case & Document has a RestAPI. This API enables other software applications to use the functionalities of JOIN Case & Document in an accessible, safe and modern way. Think for example of retrieving data and tasks, performing searches (based on JOIN Search) and creating cases and documents.
On this page you will find more information about the RestAPI: how to reach it, where to find the extensive documentation and how to use the API.
¶ What is an API?
An API is an abbreviation that stands for Application Programming Interface. An API makes it possible to offer other systems and software an “entrance” to the system. With this input different systems can communicate with each other and exchange data. In this case JOIN Case & Document and other systems. For example, JOIN Mobile also uses the RestAPI to communicate with all the functionality contained in JOIN.
To simply explain an API, people often compare it with a plug and a power strip. You can see a power strip as the system or the software. In this case you can see the plug as the API. If the plug fits into the power strip, they can communicate with each other. However, there are different types of power strips worldwide, so that they do not always fit together. The documentation of the API tells which power strips the plug actually fits.
¶ Where can I find the JOIN RestAPI?
the API comes standard with the JOIN installation, whether you are in the cloud or not. After the JOIN address, type “/ aspx / api”. You will then be automatically redirected to the index page of the API. We use Swagger, which allows you to quickly and easily navigate through all available operations of the API.
¶ How does the JOIN RestAPI work?
The JOIN RestAPI works as you can expect from a RestAPI. All kinds of operations are possible, such as retrieving documents, creating cases and handling tasks. But also searches and user information can be retrieved.
When you navigate to the API (see “where can I find the API?”) You will end up in the index page of the API. Here you will find all available types and operations. Documentation is also available with clear examples of how authentication works, how a case can be created, etc.
¶ What else is important to know?
To be able to use the RestAPI as a customer, you need a valid license for each connection that is realized on the RestAPI. For questions about this, you can contact the account manager.
In addition, a so-called system definition must be created in JOIN Mobile. This also ensures that only permitted systems can be accessed via the RestAPI JOIN. Because the API is part of JOIN Case & Document, careful attention is of course paid to authorization & security.
¶ Troubleshooting?
You receive an error message back from the RestAPI: the API has the most common error messages (no access for example) documented.
