Business Object API

The Business Object API is a HTTP interface to expose business functionality. By default it is started using the Service Hoster.

To run the Business Object API it has to be added to the services.json inside the server config directory. An example can be found in the services.boapi.example.json. The config can also be edited using the visual config editor in the TimeLine Server.

Business Object API service config

The API should use a user that is explicitly created for the API and is not used by anyone else.

The API itself reads its config from three configuration files inside the server config directory. The file api.config.json is used to configure general settings like the port it will run under, OAuth2 settings and rate limiting. The settings themselves are described using comments inside the file. Inside api.clients.json all authorized clients credentials are kept. By default it contains the Gebauer Development credentials. This should be removed or replaced by newly generated credentials.

Credentials can be generated using https://dotnetfiddle.net/ or any other C# compiler with the following code

using System;
using System.Security.Cryptography;
public class Program
{
    public static void Main()
    {
        Console.WriteLine("Guid:");
        Console.WriteLine(Guid.NewGuid().ToString());
        Console.WriteLine();
        Console.WriteLine("Secret/Hash:");
        RandomNumberGenerator cryptoRandomDataGenerator = new RNGCryptoServiceProvider();
        byte[] buffer = new byte[36];
        cryptoRandomDataGenerator.GetBytes(buffer);
        string uniq = Convert.ToBase64String(buffer);
        Console.WriteLine(uniq);
    }
}

Inside api.nlog.config the API request logger can be configured. By default the API logs the requests to C:\TimeLine\Logs\Api.json.