Skip to main content

API Documentation

Below is the technical documentation for the VirTourARt CMS API, based on the Postman collection and the system deliverables.

This API serves as the communication bridge between the Unity SDK (specifically the Setup Wizard) and the central Content Management System (CMS).

 

General Information

  • Base URL: https://cms.virtourart.gr
  • Protocol: HTTPS
  • Data Format: JSON

API Endpoints

1. Get Applications

Retrieves a list of all applications registered under the user's account.

  • Method: GET
  • URL: {{base_url}}/api/applications

  • Description: Used to fetch titles and unique identifiers (UUIDs) for the applications managed by the user.

     

2. Get Unity Packages by App UUID

Fetches the specific software packages and plugins assigned to a particular application.

  • Method: GET
  • URL: {{base_url}}/api/unity-packages/{app_uuid}
  • Path Parameters:
    • app_uuid: The unique identifier of the application (e.g., 5d0f039a-bc26-49d5-904a-f124b5f45ec1).

  • Description: Provides information on plugins (such as AR Foundation, Cinemachine, etc.) required for project setup via the Setup Wizard.

     

3. Get Assets by App UUID

Retrieves the list of digital assets (3D models, textures, sounds) available for a specific application.

  • Method: GET
  • URL: {{base_url}}/api/app-assets/{app_uuid}
  • Path Parameters:
    • app_uuid: The unique identifier of the application.
  • Description: Allows the SDK to fetch resources (such as 3D models or UI icon packs) defined by the developer in the CMS Asset Library.
  •  

Developer Workflow

  1. Access Request: The user submits a request for an account and a trial license.
  2. Identification: After approval, application UUIDs are used to call the API endpoints.
  3. Integration: The Unity SDK uses API responses to automatically download necessary bundles and resources into the project environment.