Create an Akinon UI application in ACC • Akinon UI Documentation

Akinon Commerce Cloud (ACC)

Once you create an extension app in ACC, system will bind this app to Omnitron. You can find the extension app in applications endpoint in Omnitron:


curl -X GET https://omnitron-url.lb.akinoncloud.com/api/v1/applications/?is_active=true&limit=999

Response:


{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    ...
    {
      "pk": 100,
      "name": "Example App",
      "application_type": "extension",
      "config": {
          "user_id": 74,
          "web_url": "https://example-url.lb.akinoncloud.com",
          "password": "*******",
          "username": "*******",
          "internal_url": "http://web-service.example-url.svc.cluster.local",
          "omnitron_url": "omnitron-url.lb.akinoncloud.com",
          "visible_type": "empty"
      },
      "is_active": true,
      "is_proxy_available": false,
      "remote_object_id": 14664,
      "modified_date": "2024-07-10T11:43:04.935483Z",
      "created_date": "2024-07-10T11:43:04.358197Z",
      "created_by": 1,
      "is_visible": false,
      "related_application_id": null
    },
    ...
  ]
}

You can find the visible_type field in the config and is_visible field in the application. You will need the pk field to update the application with PATCH request.

Note: You can only make the application visible in Omnitron if you have the related_application_id field is null. Otherwise, the application will be a Client Application of the related Shell Application, e.g. Seller Center.

Tip: Applicable visible_types are full_page and plugin. plugin type needs placeholder field in the config which will be described by the team of related Shell Application.

Now, if you want to make it visible in Omnitron, you need to update the visible_type field in the config and is_visible field in the application:


curl -X PATCH https://omnitron-url.lb.akinoncloud.com/api/v1/applications/100/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Token $YOUR_OMNITRON_AUTH_TOKEN" \
  -d '{
    "config": {
      "visible_type": "full_page"
    },
    "is_visible": true
  }'

Response:


{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    ...
    {
      "pk": 100,
      "name": "Example App",
      "application_type": "extension",
      "config": {
          "user_id": 74,
          "web_url": "https://example-url.lb.akinoncloud.com",
          "password": "*******",
          "username": "*******",
          "internal_url": "http://web-service.example-url.svc.cluster.local",
          "omnitron_url": "omnitron-url.lb.akinoncloud.com",
          "visible_type": "full_page"
      },
      "is_active": true,
      "is_proxy_available": false,
      "remote_object_id": 14664,
      "modified_date": "2024-07-10T11:43:04.935483Z",
      "created_date": "2024-07-10T11:43:04.358197Z",
      "created_by": 1,
      "is_visible": true,
      "related_application_id": null
    },
    ...
  ]
}

Note: Omnitron FE version must be rad2236-uip0 or higher UIP version to make UI Protocol work.