cronofy / cronofy-csharp-sample-app

Sample app to demonstrate how to use the Cronofy C# API wrapper

Cronofy C# Sample Application

Prerequisites

A Git Tool

We would recommend downloading and using the Git Bash tool, which you can find here.

A cloned version of this repository

For help in cloning this repository please see this article.

A .NET IDE

We would recommend using Xamarin Studio to build and run this project on mac and Visual Studio for Windows.

Set-up

Create a Cronofy application

To use the Cronofy C# Sample App you need to create a Cronofy application. To do this, create a free developer account, click "Create New App" in the left-hand navigation and create an application.

Once you've created your application you will need to set the cronofy_client_id and cronofy_client_secret in the application's Web.config file.

An example of how to do this:

<configuration>
  ...
  <appSettings>
    <add key="cronofy_client_id" value="{{cronofy_client_id}}" />
    <add key="cronofy_client_secret" value="{{cronofy_client_secret}}" />
  </appSettings>
</configuration>

Setting up a Remote URL

In order to test Push Notification callbacks and Enterprise Connect user authentications your application will need to be reachable by the internet.

To do this we would recommend using ngrok to create a URL that is accessible by the Cronofy API.

Once you have ngrok installed you can initialise it for your application by using the following line in your terminal:

ngrok http -host-header=localhost localhost:8080 (Replace localhost:8080 with localhost:[port number] where appropriate)

Your terminal will then display a URL in the format http://[unique identifier].ngrok.io. You will need to set the domain variable in the application's Web.config in order to test these remote features for example.

<configuration>
  ...
  <appSettings>
    ...
    <add key="domain" value="http://examplecallback.ngrok.io" />
  </appSettings>
</configuration>

cronofy-csharp-sample-app's Issues

Prompt user to use ngrok on failed callback setup

Developers are getting confused with the domain app key, we should make this more clear to them we can make this better by doing:

1. Rename app-key name to something more sensible
2. Handle errors on callback setup to prompt to install and use ngrok filling in fields for local port and generating them the setting to go into web.config along with the command for ngrok

Document setting up iis express to allow external connections