Endpoints¶

Overview¶

The Edge Delivery API is a versioned JSON API which endpoints are organized into two main groups:

v1/: grouping all the endpoints related to Resources and Pathways.
decision/: an endpoint to get the DASH/HLS Manifest along with sorted pathways.

URLs¶

API base URL: https://api.system73.com/content-steering/

Info

The documentation is available on CS-Endpoints.

The API swagger/OpenAPI reference is available on CS-Swagger.

Client Errors¶

Below you will find the client errors that might be returned by the API.

400 Bad Request¶

Not sending the required query parameter for each endpoint will result in a 400 Bad Request response.

Example of body responses:

{
    "detail": [
        {
            "loc": [
                "resource_id"
            ],
            "msg": "field required",
            "type": "value_error.missing"
        }
    ]
}

Sending a wrong value in the query parameters will result in a 400 Bad Request response. Example of body responses:

{
    "detail":[
        {
            "loc":[
                "resource_id"
            ],
            "msg":"value is not a valid integer",
            "type":"type_error.integer"
        }
    ]
}

{
    "detail": [
        {
            "loc": [
                "name"
            ],
            "msg": "string does not match regex \"^[a-zA-Z0-9\\.\\-_]*$\"",
            "type": "value_error.str.regex",
            "ctx": {
                "pattern": "^[a-zA-Z0-9\\.\\-_]*$"
            }
        }
    ]
}

401 Unauthorized¶

401 Unauthorized will be received when performing the following actions:

Not sending the authorization header will result in a 401 Unauthorized response.
Sending an invalid authorization header will result in a 401 Unauthorized response.

{
  "title": "Unauthorized",
  "detail": "Invalid authentication credentials."
}

404 Not Found¶

Doing a request to a URL that does not exist will result in a 404 Not Found response. Example of body response:

{
  "detail": "Not Found"
}

500 Internal Server Error¶

Something is wrong on our side, please contact support@system73.com:

{
  "title": "Internal Server Error"
}

This section was last updated 2024-11-18