Mini App Center - API Reference - Super App

The Mini App Center offers an API that provides endpoints for retrieving and modifying data from the Super App. 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 /superapps/{id}

 This endpoint allows you to retrieve details about a Super App identified by its unique id.

Parameters

Response

{
    "data": {
        "id": "string",
        "name": "string",
        "organization_id": "GUID",
        "security": "boolean"
    }
}

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

cURL Sample

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

POST /superapps

Creates a Super App.

Request Body

{
    "id": "string",
    "name": "string",
    "organization_id": "GUID",    /*Only with Site Admin API token*/
    "security": "boolean"
}

Response

If the creation is successful, it will return HTTP response Status "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/superapps" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "id": "com.genexus.verdantbank",
            "name": "Verdant Bank",
            "security": true
        }'

PUT /superapps/{id}

This endpoint updates a specific Super App identified by its unique id.

Parameters

Request Body

{
    "name": "string",
    "security": "boolean"
}

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/superapps/{id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "name": "Verdant Bank",
            "security": false
        }'

DELETE /superapps/{id}

Deletes a Super App identified by its unique 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/superapps/{id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

GET /superapps/{id}/attributes/{field}

Invites a member of the Super App.

Parameters

Response

{
    "data": {
        "superapp_id": "string",
        "field": "string",
        "required": "boolean",
        "type": "string",    /*CHR:Character, NUM:Number, VAL:Values*/,
        "values": [
            "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/superapps/{id}/attributes/{field}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

POST /superapps/{id}/attributes

Creates an additional attribute to the Super App identified by its unique id.

Request Body

{
    "field": "string",
    "required": "boolean",
    "type": "string",    /*CHR:Character, NUM:Number, VAL:Values*/,
    "values": [
        "string",
        ...
    ]
}

Response

If the creation is successful, it will return HTTP response Status "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/superapps/{id}/attributes" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "field": "COUNTRY",
            "required": false,
            "type": "VAL",
            "values": [
                "Argentina",
                "Uruguay",
                "Chile",
                "Bolivia"
            ]
        }'

PUT /superapps/{id}/attributes/{field}

Updates an additional attribute of a specific Super App identified by its unique id.

Parameters

Request Body

{
    "required": "boolean",
    "type": "string",    /*CHR:Character, NUM:Number, VAL:Values*/,
    "values": [
        "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/superapps/{id}/attributes/{field}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "field": "COUNTRY",
            "required": true,
            "type": "CHR"
        }'

DELETE /superapps/{id}/attributes/{field}

Deletes an additional attribute of a Super App identified by its unique 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/superapps/{id}/attributes/{field}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

GET /superapps/{id}/versions/{platform_id}/{version_id}

Gets details about a specific version of a Super App on a particular platform. 

Parameters

Response

{
    "data": {
        "superapp_id": "string",
        "id": "int",
        "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/superapps/{id}/versions/{platform_id}/{version_id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json"

POST /superapps/{id}/versions

This endpoint creates a new version for a specific Super App identified by its unique id. 

Request Body

{
    "platform_id": "string",
    "name": "string"
}

Response

If the creation is successful, it will return HTTP response Status "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/superapps/{id}/versions" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "platform_id": "iOS",
            "name": "Version for iOS"
        }'

PUT /superapps/{id}/versions/{platform_id}/{version_id}

Updates a specific version of a Super App on a particular platform.

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/superapps/{id}/versions/{platform_id}/{version_id}" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "name": "Version for iOS 1.0"
        }'

POST /superapps/{id}/versions/{platform_id}/{version_id}/disable

Disables a specific version of a Super App on a particular platform.

Parameters

Response

If the disabling 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 POST "$BASE_URL/v1/superapps/{id}/versions/{platform_id}/{version_id}/disable" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "name": "Version for iOS 1.0"
        }'

POST /superapps/{id}/versions/{platform_id}/{version_id}/enable

Enables a specific version of a Super App on a particular platform. 

Parameters

Response

If the enabling 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 POST "$BASE_URL/v1/superapps/{id}/versions/{platform_id}/{version_id}/enable" \
    -H "APIKey-Auth: $API_TOKEN" \
    -H "Accept: application/json" \
    -d '{
            "name": "Version for iOS 1.0"
        }'

GET /superapps/{id}/versions/{platform_id}/{version_id}/public_key

Gets the public key file associated with a specific version of a Super App on a particular platform. 

Parameters

Response

Gets the .crt file with the Public Key of the Super App version. If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.

cURL Sample

curl -X GET "$BASE_URL/v1/superapps/{id}/versions/{platform_id}/{version_id}/public_key" \
    -H "APIKey-Auth: $API_TOKEN" \