API for Mobile Apps

Owned by Paul Hitchcock
Last updated: Sept 01, 2023
3 min read

For versions prior to 2023-07-08, see this article instead.

In order to use the Crows Nest Mobile App, you must install and configure the API on the server that runs Crows Nest. On the server IIS must be installed and .NET ASP Application Development options turned on.

If you allow access to the API from outside your network it is recommended to purchase and configure an SSL certificate for the API

Install Crows Nest API Configurator

To install a new API or update an existing API, install and run the app Crows Nest API Configurator. To install the app select the Web API feature while installing from the latest CrowsNestSetup.msi file. A shortcut to run the app will be added to the Start menu and the desktop.

Create a Certificate

A certificate is required on the server to encrypt/decrypt tokens for authentication. To install the certificate, open the Crows Nest API Configurator and see the Certificate area. If it says Certificate Not Found, click Create Certificate and if successful it should change to Certificate Found.

 

 

Update an Existing API

If you’ve already installed an API previously and just need update it, use the following steps.

Launch the Crows Nest API Configurator app and click the Upgrade All Sites link at the top of app window. When it asks if you want to delete the previous folder, you can answer Yes, unless you would like the option of rolling back to the previous version. To roll back to a previous version use IIS to manually change the site folder to the previous folder.

 

Install a New API

If you need to install a new API, use the following steps.

  1. Customize the Root, Name, Path or Port fields if needed.

  2. Use the Load From Connections link or manually enter in the Server and Database fields for the Crows Nest database that the API will connect to.

  3. Click the Create a new site with these settings link to create the Site.

 

Other Info

  • To change Port numbers for existing APIs, edit the Bindings in IIS Manager

  • Port numbers used are arbitrary, you can use any port you like as long as there is no conflict with other applications

  • To edit the Server and Database fields on an existing site you can edit those fields in the list of loaded sites and it will offer to update the connection string in the Web.config file. The connection string in the Web.config file will be encrypted by default. You can manually encrypt/decrypt it if needed by right-clicking on the site in the list of loaded sites.

  • To install an SSL certificate, use IIS Manager. Walk throughs for installing SSL certificates in IIS are typically provided from certificate vendors and are available online.