Notice! This documentation is outdated & will no longer be updated.

We've recently moved to https://docs.intellivoid.net/

Intellivoid API

Intellivoid API is a new standard which replaces the old ModularAPI Which was created by Intellivoid, a closed-source solution for providing a stable, fast performing API service.

Intellivoid API Much like ModularAPI does the same but introduces more improvements and more organized structures.

This document explains how to authenticate to Intellivoid API when using an API from Intellivoid.

Authentication Methods

The following authenitcation methods are available

Basic HTTP Authentication
GET/POST Parameter

Basic HTTP Authentication

You can authenticate by providing your access key via the password field, the username can be left blank and you should not provide your access key via a username.

GET/POST Parameter

You can provide your access key via a GET Parameter or within a POST (multipart/form-data), the parameter name that is applicable to both methods is access_key, for example.

https://api.intellivoid.net/example/v1/echo?access_key=<access key>&input=Hello

Security Notices

All official APIs by Intellivoid are done through api.intellivoid.net, followed by the service name and version of API Handler. For example

https://api.intellivoid.net/<service name>/<version>/<method>

Any unauthorized requests will result in a 401 Unauthorized response such as this

{
    "success": false,
    "response_code": 401,
    "error": {
        "error_code": 0,
        "type": "CLIENT",
        "message":
        "Unauthorized Access, Authentication is required"
    }
}

Additionally WWW-Authenticate: Basic realm="API Authentication" will be provided in the response headers, if you are using a web browser you will be prompted to authenticate, you can authenticate by providing your Access Key in the password field as explained above.

Netkas/intellivoid_api_authentication.md