General State (state.init)

About Method

This method is used to obtain general information about the API. With it, you can find out the current version of the API and compare it with the version of your SDK.

Receiving the information

To get general information about the API, you need to send a POST request to the following URL:

https://cp.ocugine.pro/api/state/init/

or:

https://cp.ocugine.pro/api/state/

After which the server will issue the following information:

{
    "complete":true,
    "message":null,
    "data":{
        "version":"0.4.0a",
        "build":401,
        "developer":"CodeBits Interactive",
        "url":"https://cp.ocugine.pro/",
        "online":true
    }
}

Where:

Param Type Usage
complete bool Operation state. If false - request has error
message string Error Message. If complete = true, when message will be null.
data Object Contain general API information

Data Object:

Param Type Usage
version string Current API version
build int Current API version build number
developer string Name of API developer
url sting API server url
online bool General API state. If false - server is currenlty under construction.