× Docs Platform Dashboard Extensions Applications Building Merchants Sign in

Quick guide

There are a couple ways to get started with the Rehive platform API:

  1. You can choose to use one of the Rehive supported SDKs or
  2. Integrate the API manually in your choice of language.

To use one of the SDKs check for you language in the “references list” in the sidebar. If you instead want to use a language that does not have a Rehive supported SDK, a custom implementation should be trivial as the platform uses standard HTTP which is widely supported.

Using the API

The easiest way to get started with the API is to login to the dashboard and create a new API token for your user. You can create a new API token in the Developers -> API tokens section in the dashboard. Once an API token is created, it will be displayed only once. So make sure you copy it before closing the modal. For security reasons API tokens are hashed and as such the platform cannot retrieve (or display) the token value except immediately after creation.

You can use the new API token to authenticate your requests to the API. For example, if you want to get user information (for the user who owns the API token) you can call the API like this (using cURL):

curl https://api.rehive.com/3/user/ \
  -X GET \
  -H "Authorization: Token {token}" \
  -H "Content-Type: application/json"

Make sure that you replace the {token} (including the curly brackets) with the API token. If above request is successful, you should get a response like this:

{
    "status": "success",
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "first_name": "Joe",
        "last_name": "Soap",
        "email": "[email protected]",
        "username": "",
        "id_number": null,
        "birth_date": null,
        "profile": null,
        "currency": null,
        "company": "rehive",
        "language": "en",
        "nationality": "ZA",
        "metadata": {},
        "mobile": "+00000000000",
        "timezone": null,
        "verified": false,
        "status": "pending",
        "verification": {
            "email": true,
            "mobile": true
        },
        "groups": [
            {
                "name": "admin",
                "label": "Admin"
            }
        ],
        "permissions": [],
        "settings": {
            "allow_transactions": true,
            "allow_debit_transactions": true,
            "allow_credit_transactions": true
        },
        "created": 1464912953000,
        "updated": 1464912953000
    }
}

You can access any endpoint and method your API token has permission to access. For example, you may want to get a list of emails associated to your user:

curl https://api.rehive.com/3/user/emails/ \
  -X GET \
  -H "Authorization: Token {token}" \
  -H "Content-Type: application/json"

You will get a response like this:

{
    "status": "success",
    "data": [
        {
            "id": 1,
            "email": "[email protected]",
            "primary": true,
            "verified": true
        }
    ]
}

Or as a final example, you may want to update your user details. When updating, the platform requires the PATCH method to be used instead of the GET method. You will also need to send a JSON formatted http body in your request:

curl https://api.rehive.com/3/user/ \
  -X PATCH \
  -H "Authorization: Token {token}" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Joseph"}'

To learn more about what you can do in the platform, take a look at the API Reference, which contains the full API specification.