REST API

(Detailed documentation: https://developer.algolytics.pl/api-details#api=scoring-one-rest-api-documentation)

Authorization through API keys.

All operations possible in the engine are available from the REST API level. Individual scenarios or ML models can be called by API. This enables the control of the core configuration by external applications. Operations are executed directly on the engine's calculation units. Available API methods:

• Creating, deleting accounts

• Adding, removing scoring models

• Adding, deleting decision scenarios

• Downloading model definitions and decision scenarios

• Adding, loading and deleting data from internal databases

• Retrieving engine configuration information (list of scenarios, models, data in internal databases)

The most commonly used API endpoints are for executing scenarios and models.

API endpoint structures:

• for scenario:

  • https://<SERVER ADDRESS>/api/scenario/code/remote/score?name=<SCENARIO NAME>&key=<AUTH KEY>

• for model:

  • https://<SERVER ADDRESS>/api/scoring/code/remote/score?name=<SCENARIO NAME>&key=<AUTH KEY>

Authentication key can be obtained in the main menu in User settings section. Note that you need to copy a value of a Score Token not an Authentication Token .