Authentication

Inokufu web services APIs offer two methods of authentication: API key and OpenID.

API key

An API Key is a code assigned to a specific user or application when they register or subscribe to use an API. This key is sent along with each request, allowing the system to verify the identity of the request maker. All plans include authentication by API Key.

Inokufu APIs expect the API key to be included in API requests to the server in a header that looks like the following:

"x-api-key": "SAY-FRIEND-AND-ENTER"

Make sure to replace SAY-FRIEND-AND-ENTER with your own Developer API key.

You can manage your API Key using Inokufu APIs Gateway portal here.

Code example

See below for an example of access with the API key in header:

 curl "apiendpointhere" -H "x-api-key: SAY-FRIEND-AND-ENTER"

OpenID

OpenID is a standard for user authentication that allows users to be authenticated by certain co-operating sites (known as Relying Parties) using a third-party service. This means that users can log on with an OpenID to any website which accepts OpenID authentication. All paid plans include authentication with OpenID.

Inokufu APIs can also use authentication using OpenID token. This can be set up using Inokufu APIs Gateway portal here.