Jiwa REST API Service won't start

 The Jiwa Self-Hosted REST API Service won’t start

When the Jiwa API Service won’t start, the first thing to do is to check the event log in Event Viewer.

Open

Event Viewer will give you the reason it fails to start, even if sometimes the reason appears nebulous to a user. Look for Jiwa7APISelfHostedService as the Source and always use the Error event level, rather than Information level.

Open

Here are your most common reasons for the API service not starting

1. No available licences for the user defined in the API config file

2. Misconfigured config file

3. The API service can’t reach the SQL Server

4. Custom plugins are failing to compile or causing issues

5. Something else is running on the same port as the API has been configured for

6. There are too many webhook messages pending being sent.

 Solution

Here’s how to troubleshoot each of the reasons above:

1. Check the licences assignment in the Jiwa System Settings > Licencing form. The API service should be explicitly assigned a licence. Non-interactive licences are available for purchase for use by services only. Try logging in to Jiwa as the API user. (Don’t use Admin for API - you want to be able to distinguish between API activity and user activity in the database. Admin user should be disabled anyway).

2. Check your config file in C:\Program Files (x86)\Jiwa Financials\Jiwa 7\JiwaAPISelfHostedService.exe.config. Copy paste details, don’t type them. The settings in the config file should match your About page on any Jiwa form.
   
   

   Open

   

3. Check your network connections and firewalls. Ping the SQL Server from the Application Server. Log into the database from the app server using Jiwa.

4. Make sure there are no Plugin Exceptions when you log in. Check the Start Up Diagnostics form in Jiwa (right-mouse click on the key and padlock). Try disabling all custom plugins to see if the API starts. Then enable them one by one, re-starting the service each time until you find the culprit.
   
   

   Open

   

    

5. Try editing the config file to use another port. The default port is 80. Try using 81 or 8080.

6. Every time the API Service starts or re-starts it checks the SY_Webhook message table to see if there are webhook messages needing to be sent. Messages needing to be sent include those that are 0 - Not Sent and 2 - Failed, Retry Pending. These can add up over time if they’re not being monitored or your webhook subscribers are mis-configured.
   Run a SQL Query to see how many messages are in the queue

   SELECT * FROM SY_WebhookMessage WHERE Status = 0 OR Status = 2

   
   If there are too many (1000s), delete them.

   DELETE FROM SY_WebhookMessage

   Note, this is one of those circumstances where the Event Viewer message may be nebulous. It will read as:

 Related articles