Docker client setup

The sproof API client is capable of registering, revoking and verifying data with an existing sproof account. It comes as a ready-to-use docker image that needs to be set up before its use. This document explains the prerequisites, the actual setup and the operation of the docker client.

Prerequisites

The sproof API client is based on Docker Compose and requires a sproof account.

Docker Compose

Before you can set up the docker client, you need to install Docker and Docker Compose on the machine where you want to install the API client. Please refer to the linked documentation for installation instructions for your operating system.

sproof account

In addition, a sproof account is required. Visit Create your sproof profile for instructions on how to create an account. Note that testing is possible with a free account, while production-level operation requires a premium account.

Setup instructions

1. Get sproof-client-api

The sproof docker API client is available at https://github.com/sproof/sproof-client-docker. You can obtain the client either through git or through a regular download.

If you have git installed on your machine, you can use it to download the client:

git clone https://github.com/sproof/sproof-client-docker.git

Download the source file archive and unpack the downloaded archive, e.g., with the following commands on Linux:

wget https://github.com/sproof/sproof-client-docker/archive/master.zip
unzip master.zip
rm master.zip

On Windows, the following PowerShell commands (require v5 or higher) do the same:

wget https://github.com/sproof/sproof-client-docker/archive/master.zip -OutFile master.zip
Expand-Archive master.zip -DestinationPath .
Remove-Item master.zip

After this step, you have a folder named sproof-client-docker containing the source files of the docker client. This folder is the basis for all subsequent steps.

2. Set the docker client configuration

Set your sproof code and (optionally) other parameters based on your needs in the data/config.js file. Please find a detailed description of the parameters in Configuration of the docker image.

Operation instructions

Once the required configuration files are in place, the client can be started. As soon as it is running, you can access the docker client API through it.

In order to start the docker API client, run

docker-compose up

After the build process completes successfully, an access code will be output both, on the console and in data/accessCode.json. The output on the console looks like this:

../_images/access-code-output.png

The access code is a token which secures your API endpoint. It is is necessary for sending and processing most external API requests.

The client, it will be started automatically. It will host an API endpoint as well as the verifier on port 6001 through a Web server.

Accessing the API

Once the docker client is running, you can access the client API through it. Note that, for most API calls, you need the access code that has been output during the start process. For a detailed documentation of the API endpoint as well as examples in multiple common programming languages, please see docker client API.