The Mini App Center offers an API that provides endpoints for retrieving and modifying data from the Mini App. This article offers an overview of these Endpoints.
Check the generic variables required to use the API.
Below is a summary of the available endpoints for this API:
This endpoint gets details about a specific Mini App identified by its unique id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
{
"data": {
"id": "string",
"organization_id": "GUID",
"name": "string",
"description": "string",
"superapp_id": "string",
"type": "string",
"keywords": "string",
"icon": "URL",
"card": "URL",
"banner": "URL",
"additional_attributes": [
{
"field": "string",
"value": "string"
},
...
]
}
}
If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.
curl -X GET "$BASE_URL/v1/miniapps/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Uploads a Bundle file to create a Mini App with additional attributes and locations. Note that the file extension must be ".mac" or the one indicated in the "File Types" parameter.
The supported option is binary. It is useful for its simplicity and encodes the binary data directly in the request body.
It is mandatory to set a filename header value with the document name and extension. For example:
filename: MiniApp.mac
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 -X POST "$BASE_URL/v1/miniapps/upload" \
-H "APIKey-Auth: $API_TOKEN" \
-H 'filename: MiniApp.mac' \
-d '@/C:/temp/MiniApp.mac'
Creates a Mini App.
{
"id": "string",
"organization_id": "GUID", /*Only with Site Admin API token*/
"name": "string",
"description": "string",
"superapp_id": "string",
"type": "string", /*Native, WEB*/
"keywords": "string",
"icon": "object_id",
"card": "object_id",
"banner": "object_id"
}
To learn how to generate an "object_id" read HowTo: Upload an image, video, or audio file via an API object Using Postman.
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 -X POST "$BASE_URL/v1/miniapps" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"id": "com.genexus.verdant.coffeemuffins",
"name":"Coffee & Muffins",
"superapp_id":"com.genexus.verdantbank",
"type":"native",
"description":"Coffee & Muffins Mini App",
"keywords":"coffee cafe muffins breakfast",
"icon":"gxupload:fe4602263a224b68a6cdd8c5533e5700"
}'
Updates details of a specific Mini App identified by its unique id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
{
"organization_id": "GUID", /*Only with Site Admin API token*/
"name": "string",
"description": "string",
"superapp_id": "string",
"type": "string", /*Native, WEB*/
"keywords": "string",
"icon": "object_id",
"card": "object_id",
"banner": "object_id"
}
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 -X PUT "$BASE_URL/v1/miniapps/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"name":"Coffee & Muffins",
"superapp_id":"com.genexus.verdantbank",
"type":"native",
"description":"Coffee & Muffins Mini App",
"keywords":"coffee cafe muffins breakfast",
"icon":"gxupload:fe4602263a224b68a6cdd8c5533e5700",
"card":"gxupload:32d77315af2a45aea39b99bb7b5a07a9"
}'
Deletes a Mini App identified by its id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
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 -X DELETE "$BASE_URL/v1/miniapps/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Assigns a value to an additional attribute of a Mini App identified by its id.
{
"field": "string",
"value": "string"
}
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 -X POST "$BASE_URL/v1/miniapps/{id}/attributes" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"field": "COUNTRY",
"value": "Uruguay"
}'
Deletes an additional attribute of a Mini App identified by its id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| field |
string |
Field (required) |
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 -X DELETE "$BASE_URL/v1/miniapps/{id}/attributes/{field}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
This endpoint gets a list of locations associated with a Mini App identified by its id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| location_id |
string |
Location ID (required) |
{
"data": [
{
"id": "int",
"name": "string",
"geo_point": "GeoPoint"
},
...
]
}
If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.
curl -X GET "$BASE_URL/v1/miniapps/{id}/locations/{location_id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Creates a new location associated with a Mini App identified by its id.
{
"name": "string",
"geo_point": "GeoPoint"
}
GeoPoint: Geography object represented by the WKT text (https://en.wikipedia.org/wiki/Well-known_text).
Sample: "POINT(-56.163740158081055 -34.92478600243492)"
{
"data": {
"id": "int"
}
}
If the creation is successful, it will return HTTP response Status "201 Created". Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/miniapps/{id}/locations" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"name": "Central",
"geo_point": "POINT(-56.163740158081055 -34.92478600243492)"
}'
Updates the details of a specific location associated with a Mini App.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| location_id |
string |
Location ID (required) |
{
"name": "string",
"geo_point": "GeoPoint"
}
GeoPoint: Geography object represented by the WKT text (https://en.wikipedia.org/wiki/Well-known_text).
Sample: "POINT(-56.163740158081055 -34.92478600243492)"
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 -X PUT "$BASE_URL/v1/miniapps/{id}/locations/{location_id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"name": "Central",
"geo_point": "POINT(-56.163740158081055 -34.92478600243492)"
}'
Deletes a specific location associated with a Mini App.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| location_id |
string |
Location ID (required) |
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 -X DELETE "$BASE_URL/v1/miniapps/{id}/locations/{location_id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Gets details about a specific version of a Mini App.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
{
"data": {
"id": "int",
"code": "string",
"platform_id": "string",
"metadata": "URL",
"integrated_security": "boolean",
"main_name": "string",
"main_type": "string",
"service_url": "URL"
}
}
If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.
curl -X GET "$BASE_URL/v1/miniapps/{id}/versions/{version_id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Uploads a Bundle file to create a version of mini app {id}. Note that the file extension must be ".mac" or the one indicated in the "File Types" parameter.
The supported option is binary. It is useful for its simplicity and encodes the binary data directly in the request body.
It is mandatory to set a filename header value with the document name and extension. For example:
filename: MiniAppVersion.mac
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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/upload"\
-H "APIKey-Auth: $API_TOKEN" \
-H 'filename: MiniAppVersion.mac' \
-d '@/C:/temp/MiniAppVersion.mac'
This endpoint creates a new version of the Mini App identified by its id.
{
"code": "string",
"platform_id": "string",
"metadata": "object_id",
"integrated_security": "boolean",
"main_name": "string",
"main_type": "string", /*Panel, Menu*/
"service_url": "URL"
}
To learn how to generate an "object_id" read HowTo: Upload an image, video, or audio file via an API object Using Postman.
{
"data": {
"id": "int",
"code": "string",
}
}
If the creation is successful, it will return HTTP response Status "201 Created". Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/miniapps/{id}/versions" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"platform_id": "iOS",
"metadata": "gxupload:f292ef3f9ac94294a66cc353c4802c35",
"integrated_security": true,
"main_name": "startObject",
"main_type": "Panel",
"service_url": "https://apps6.genexus.com/Id555317f4080a0da816dc4eb15d69bc1b/"
}'
Updates an existing version of a Mini App.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
{
"platform_id": "string",
"metadata": "object_id",
"integrated_security": "boolean",
"main_name": "string",
"main_type": "string", /*Panel, Menu*/
"service_url": "URL"
}
To learn how to generate an "object_id" read HowTo: Upload an image, video, or audio file via an API object Using Postman.
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 -X PUT "$BASE_URL/v1/miniapps/{id}/versions/{version_id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"platform_id": "iOS",
"metadata": "gxupload:f292ef3f9ac94294a66cc353c4802c35",
"integrated_security": true,
"main_name": "startObject",
"main_type": "Panel",
"service_url": "https://apps6.genexus.com/Id555317f4080a0da816dc4eb15d69bc1b/"
}'
Adds compatibility with the version of a Super App in the Mini App version.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
{
"superapp_version": "int"
}
If the compatibility is successfully added, 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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/compatibility" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"superapp_version": 1
}'
Deletes compatibility with the version of a Super App in the Mini App version.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
{
"superapp_version": "int"
}
If the compatibility is successfully deleted, 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 -X PUT "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/compatibility/delete" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"superapp_version": 1
}'
Sends to review a particular version of a Mini App identified by its id.
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
If status setting 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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/send_to_review" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
Sets a version of a Mini App as "in review".
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
If status setting 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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/in_review" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
This endpoint sets a version of a Mini App identified by its id and as "rejected".
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
If status setting 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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/rejected" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
Sets a version of a Mini App identified by its id as "ready".
| Name |
Type |
Description |
| id |
string |
Mini app ID (required) |
| version_id |
int |
Version ID (required) |
If status setting 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 -X POST "$BASE_URL/v1/miniapps/{id}/versions/{version_id}/ready" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \