Mini App Center - API Reference - Platform

The Mini App Center offers an API that provides endpoints for accessing and modifying data within the Platform. This article contains an overview of these endpoints.

Check the generic variables required to use the API.

Endpoints

Below is a summary of the available endpoints for this API:

 

GET /platforms

This endpoint allows you to obtain a list of all available Platforms.

Response

{
    "data": [
        {
            "id": "string",
            "name": "string"
        },
        ...
    ]
}

If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X GET "$BASE_URL/v1/platforms" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

Pay close attention to the returned ID element that is needed for other related APIs.

GET /platforms/{id}

This endpoint allows you to retrieve details about a specific Platform identified by its unique id.

Parameters

Response

{
    "data": {
        "id": "string",
        "name": "string"
    }
}

If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X GET "$BASE_URL/v1/platforms/{id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

POST /platforms

This endpoint is used to create a new Platform.

Request Body

{
    "id": "string",
    "name": "string"
}

Response

If the creation is successful, it will return HTTP StatusCode "201 Created" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X POST "$BASE_URL/v1/platforms" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "id": "TST",
            "name": "Testing"
        }'

PUT /platforms/{id}

This endpoint updates an existing Platform, identified by the id.

Parameters

Request Body

{
    "name": "string"
}

Response

If the update is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X PUT "$BASE_URL/v1/platforms/{id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "name": "Testing"
        }'

DELETE /platforms/{id}

This endpoint is used to delete a Platform with a specific id.

Parameters

Response

If the deletion is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X DELETE "$BASE_URL/v1/platforms/{id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"