API State Object

Introduction

This object displays the current status of the work of API services. You can track the status of services, as well as a list of available services to work through the Direct API.

This is the official API state. If one of the API services does not work for you, please contact our support team. Do not forget that some API methods may be in the process of testing. You can find out about this on this page.

Available Methods

Use following methods to get API State. Object / Method URL Description
State.init https://cp.ocugine.pro/api/state/init/ Use this method to get general Ocugine API State.
State.get_state https://cp.ocugine.pro/api/state/get_state/ Use this method to get information about every Ocugine Services State.

General State

In order to get a general state of Ocugine Direct API, you must send a POST request to:

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

Calling this method does not require sending parameters.

Response Example

{
    "complete": true,
    "message": null,
    "data": {
        "version": "0.9.1b",
        "build": 902,
        "developer": "Intelligence Solutions",
        "url": "https://cp.ocugine.pro/api/",
        "online": true
    }
}

Where data object contain following parameters:

Name Type Desc
version string API Version
build double API Version
developer string API Developer Company Name
url string API URL
online boolean API Global status. false = server is offline

Services State

In order to get a services state of Ocugine Platform, you must send a POST request to:

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

Calling this method does not require sending parameters.

Response Example

{
    "complete": true,
    "message": null,
    "data": {
        "dashboard": 2,
        "services": {
            "users": {
                "auth": 2,
                "lists": 2,
                "groups": 2,
                "notifications": 2,
                "support": 2,
                "chating": 2,
                "reviews": 2,
                "policy": 2,
                "settings": 2
            },
            "analytics": {
                "general": 2,
                "user_tracking": 1,
                "events": 2,
                "funnels": 2
            },
            "marketing": {
                "tools": 2,
                "promo": 2,
                "ab": 2,
                "aso": 1
            },
            "ads": {
                "exchange": 1,
                "ads": 1
            },
            "gaming": {
                "leaderboards": 2,
                "achievements": 2,
                "teams": 2,
                "store": 1,
                "multiplayer": 1,
                "security": 1,
                "social": 2,
                "cross_play": 2,
                "missions": 2
            },
            "cloud": {
                "content": 2,
                "databases": 2,
                "backend": 1,
                "testing": 1,
                "build": 1,
                "reporting": 2,
                "perfomance": 2
            },
            "office": {
                "chating": 2,
                "notifications": 2,
                "events": 2,
                "grants": 2,
                "project_management": 2,
                "payments": 2,
                "settings": 2
            },
            "reports": {
                "payouts": 1,
                "errors": 2,
                "usage": 2,
                "perfomance": 1,
                "custom": 1
            },
            "localization": {
                "manager": 2,
                "languages": 2
            },
            "other": {
                "integrations": 1,
                "sdk": 2,
                "launcher_builder": 1,
                "api_manager": 2
            }
        }
    }
}

For every Services state object has dynamic parameter. Where every parameter - this is a flag showing the status of the service as an integer mask.

Mask Value Description
0 Service unavailable
1 Service is not tested or unstable
2 Service is stable