REST API #

Let us change our traditional attitude to the construction of programs. Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do. – Donald Knuth

The AppKey REST API provides interfaces for a client device to access the AppKey REST service, which is at https://api.appkey.io, when using the AppKey authentication system.

The primary purpose of the AppKey REST API service is to provide a client side application with functions to access the AppKey authentication service.

Headers #

Request Headers #

Unless specified otherwise, requests must have the following headers:

	{
        app-token: "<App Token>"
	}
	or 
	{
        access-token: "<Access Token>"
	}

The app-token request is done if the user is not logged in. The access-token request is done if the user is logged in.

The app-token is retrieved from the AppKey Portal in the application detail under by the developer in the Keys section of the specific app. The app-token is only known by the developer and is associated with the application. The AppKey service uses this app-token to verify developer identity to authorize access to the application.

The access-token is returned to the client when a user is authenticated by the AppKey REST API for the AppKey authentication service, it is returned alongside the JWT token for the user logging in. The access-token is associated with a particular user of the application, this is different from the app-token that is associated with a developer.