Region Specific API URLs

Making API calls on Region Cloud accounts

The process of calling the Rule Solver, Managment API or BI API is the same for region-locked accounts and Global Cloud accounts. The only difference is the endpoint URL.

With the Regional Cloud accounts having to prepend the URL with their respective regional shortcut.

Location	Shortcut	API call URL example
USA	us	https://us.api.decisionrules.io/:PATH
European Union	eu	https://eu.api.decisionrules.io/:PATH
Australia	au	https://au.api.decisionrules.io/:PATH

A few examples

Solving a rule through the Solver API

Let's say you want to solve a rule on an account registered in the United States. We would follow the instructions in the Rule Solver API article and simply prepend the usual URL with our region's shortcut. In this case 'us', forming the following request:

Solve Rule

POST https://us.api.decisionrules.io/rule/solve/:ruleId/:version

Path Parameters

Name	Type	Description
ruleId*	string	Unique identifier rule that is common to all rule versions. Instead of rule ID, it is possible to use rule alias.
version	integer	Business rule version. If the parameter is not filled in, the last published version will be used automatically. See more on versioning.

Headers

Name	Type	Description
Authorization*	string	Bearer <Solver API Key>
Content-Type	string	application/json
X-Strategy	string	STANDARD or ARRAY or FIRST_MATCH. More in execution strategies
X-Correlation-Id	string	Correlation ID, in case you would like to set it manually. If not present, correlation ID will be generated automatically. In any case, the correlation ID is returned in the same header of the response.
X-Audit	string	Decides whether an audit of the solve should be created and saved. In case you want the audit to be created and saved, input "true".
X-Audit-Ttl	string	A number that dictates after how many days the audit will be deleted. Set to 14 days by default.
X-Debug	string	Allows to switch on the debug mode, which is by default off. Set this header to "true" if you want to activate it.

Request Body

Name	Type	Description
data	object	JSON object that describes the input json data.
options	object	Object specifying solver options.

200 Rule Solved

[
    {
        "car": {
            "price": "666666",
            "seats": {},
            "discount": {
                "low": "2",
                "high": "33"
            }
        }
    },
    {
        "car": {
            "price": "8888888",
            "seats": {},
            "discount": {
                "low": "8",
                "high": "33"
            }
        }
    }
]

400

{
    "error": {
        "message": "Unknown rule or rule version"
    }
}

401 Could not find matching rule

{
    "error": {
        "message": "Authentication token missing"
    }
}

Updating a rule through the Managment API

Let's say you want to update a rule on an account registered in the EU. We would follow the instructions in the Management API article and simply prepend the usual URL with our region's shortcut. In this case 'eu', forming the following request:

Update rule

PUT https://eu.api.decisionrules.io/api/rule/:ruleId/:version

Path Parameters

Name	Type	Description
rule Id	string	Unique rule ID which is common to all rule versions. You can also use rule alias.
version	integer	Version of Rule

Headers

Name	Type	Description
Authorization	string	Bearer

Request Body

Name	Type	Description
body	object	JSON format of a rule

200 The rule has been updated

400

TypeError: rule.decisionTable.rows is not iterable

401

{
    "error": {
        "message": "Authentication token missing"
    }
}

Getting Console Logs for a rule solve through the Console Logs API

Let's say you want to get console logs for a rule solve on an account registered in Australia. We would follow the instructions in the Console Logs API article and simply prepend the usual URL with our region's shortcut. In this case 'au', forming the following request:

Get Console Logs for a solve

GET https://au.api.decisionrules.io/consoleLogs/:correlationId

Query Parameters

Name	Type	Description
correlationId*	String	CorrelationId of specific solve

Headers

Name	Type	Description
Authorization*	String	Bearer <Solver API Key>