Get started

Welcome to the Kionova API. This guide will help you use our API to access Kionova API endpoints, therefore, we recommend that you use this particular documentation and contact us for assistance in case of unclear questions. info@kionova.com

Important terminology

Please understand the terminology of our API before you start using it.


Basic definitions

Title Value Remarks
API Access URL [YOUR-SITE-URL]/mobile_api/[ENDPOINT_TYPE] URL address for access to API Must be as shown in the example. E.g. https://kionova.org/mobile_api/login
Auth token POST https://kionova.org/mobile_api/feeds with field session_id=[YOUR-AUTH-TOKEN] Most of the user's actions require authorization, for example liking a post or checking whether the user follows a profile. Send the auth_token returned by mobile_api/login as the session_id field with every request while the user is logged in. Prefer a POST field over the query string, so the token does not end up in server logs.
Response data type {...} The server response to your API request will be in JSON format
Token lifetime 24 hours An auth_token is valid for 24 hours (see auth_token_expiry). Get a new one with mobile_api/refresh_access_token and the refresh_token. mobile_api/logout ends only the session of the token sent.
Page size max. 50 For list endpoints, page_size defaults to 20; values above 50 are reduced to 50.
Rate limits HTTP 429 Requests are limited per IP address. login, signup, resetpassword, oauth and refresh_access_token allow about 12 requests per minute; all other endpoints about 10 per second.

General error responses

Endpoint responses use code / message / data. The following errors come from the API itself and use a different format: 

{
        "status": "400",
        "err_code": "invalid_endpoint",
        "message": "Invalid endpoint error on API call"
    }
    
{
        "status": "400",
        "err_code": "api_is_disabled",
        "message": "Unfortunately, the system API of Kionova Network is temporary not available."
    }
    
{
        "status": 400,
        "error": "Invalid access token"
    }
    
{
        "status": 500,
        "message": "Internal server error"
    }