Create Application

Email the AWS access key of the IAM User to developers@xineoh.com

After that you can make authorised API calls and create your first application.

Create Application API Call

POST - /organization/create-application
Params: { version: v3.0 }
Body: {
name: ‘APPLICATION_NAME’,
description: ‘APPLICATION_DESCRIPTION’,
domain: ‘APPLICATION_DOMAIN’,
application_type: ‘retail’
}

For more information on the body parameters please see the official documentation here.

Successful Response:

{
    "status_code": 200,
    "response": {
        "success": "Application created successfully"
    }
}

And just like that, you have your first application.

For the next step, you will need to see all the applications in your organisation and get the ID of your newly created application.

View Applications API Call

GET - /organization/applications
Params: { version: v3.0 }

Successful Response:

{
    "status_code": 200,
    "response": [
        {
            "application_id": "APPLICATION_ID",
            "app_id": "STRING_APPLICATION_ID",
            "application": "APPLICATION_NAME"
        }
    ]
}

Change Application

When you log in for the first time, the application_id will be empty for your organisation. When using the Xineoh Consumer Behaviour API, you must select an application before performing specific actions. Once an application has been selected, it will remain selected until a different application is chosen.

You will select your newly created application in the following API call.

Change Application API Call

POST - /organization/change-application
Params: { version: v3.0 }
Body: { application_id: APPLICATION_ID }

Successful Response:

{
    "status_code": 200,
    "response": {
        "refresh_token": "REFRESH_TOKEN",
        "application_id": "YOUR_APPLICATION_ID",
        "application_app_id": "YOUR_APPLICATION_STRING_IDENTIFIER",
        "application": "YOUR_APPLICATIONS_NAME",
        "application_type": "media"
    }