...
...
...
...
...
...
...
...
Info |
---|
openIMIS components: REST API v1API v1.0.0+, Database v1.4.0+, Web Application v1.4.0+ |
Video tutorial
Excerpt |
---|
Prerequisites In order to install openIMIS REST API, you need first to install openIMIS Database and openIMIS Web Application. |
...
If not yet installed, please follow the steps from the database installation and web application installation guides. |
...
Download openIMIS |
...
REST API Download and unzip the release from Github |
...
...
...
c-sharp repository under the IIS' wwwroot (C:\inetpub\wwwroot). Install required libraries openIMIS REST API is developed in the .NET Core open-source framework. Download and install the required libraries for .NET Core 2. |
...
1. Configure openIMIS REST API in IIS The openIMIS REST API can be installed as a separate website or as an application within the openIMIS Web Application website. The following instructions are for the second case. In Internet Information Service (IIS) Manager, right-click on the openIMIS Web Application website and select
Configure openIMIS REST API Edit appsettings.Production.json file:
|
...
Edit appsettings.json file:
|
...
Add rewrite rule for Image folder The Image folder is used by both Web Application and Mobile Applications. Usually, we keep only one folder for all the images under the Web Application folder. From the mobile phone, the Images path is added to the configured REST API base URL which doesn't exist. Based on the previous configurations, add the following URL rewrite rule.
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
Test the installed REST API To access and test the newly installed REST API, open your browser and navigate to http://127.0.0.1/rest/api-docs. openIMIS demo server REST API For testing purposes, you can access the openIMIS demo server REST API: https://demo.openimis.org/rest/api-docs/index.html?urls.primaryName=V2%20Docs |