Keykit API Documentation

Some basic documentation on our API.

Keykit API

Preface

Here at Keykit we really want to collect as much data as we can. We are happy to comb through it as we, well enjoy it! In an effort to make it as easy as possible for people to submit data to our collection we have an API that is open to anyone with an account. Below you can find a list of our endpoints as well as some help, snippets and examples of using our API.

If you feel that something is either not working as intended, or is would like to see something else added to our API please feel free to contact me.


Getting started.

First up you will need an API key to use our API. One of these can be had for free, simply create an account with us and we’ll generate an API key for you when your account is created. We use this API key to authenticate the user talking with our API.

It should be noted that this is your API key, and you should not share it with anyone else. This API key is tied to your account and everything that it’s used for will be logged.


Querying Our API

Our API can be queried using the following format: https://keyk.it/api/ followed by the desired endpoint. With this you also need to include your API key, and this can be done in one of several ways.

Query String

You can simply pass it as a query string using the key api_token and the value.

curl https://keyk.it/api/user?api_token=2o8mRpTdUHSjpObRyUAxW4Ffi4IPBlK12FzXvLa5owGBwfhamy332r5gNxTqDlT7XePwMO5k25jr89eh
Request Payload

The form parameter api_token may also be included as if it was being submitted via a POST request.

curl --data "api_token=2o8mRpTdUHSjpObRyUAxW4Ffi4IPBlK12FzXvLa5owGBwfhamy332r5gNxTqDlT7XePwMO5k25jr89eh" https://keyk.it/api/user
Bearer Token

Your also welcome to provide the api_token as a Bearer token in the Authroization header of the request.

curl -H 'Accept: application/json' -H "Authorization: Bearer 2o8mRpTdUHSjpObRyUAxW4Ffi4IPBlK12FzXvLa5owGBwfhamy332r5gNxTqDlT7XePwMO5k25jr89eh" https://keyk.it/api/user

API Endpoints