- XRCLOUD를 이용한 자체 공간 관리 도구를 개발하기 위한 CRUD API에 대한 설명입니다.
I. Scene Management
1. [Create] Launch Spoke Editor
- API Endpoint:
https://api.xrcloud.app/api/scenes/get-creation-url
- API Documentation: Scene Creation URL
- Description:
- This API is used to obtain the URL for accessing the Spoke editor to create a scene.
- It requires the
X-XRCLOUD-API-KEY
for authentication and allows setting values for creator
and callback
.
creator
: This can be set per administrator account or user. It acts like a filter for users and can also use an internally managed UUID. If not specified, it is treated as created by the Admin.
callback
: The URL to return to after the Spoke editor session, whether after editing or canceling.
2. [Read] Retrieve Scene List
- GET API:
https://api.xrcloud.app/api/scenes
- API Documentation: Get Scenes
- Description:
- This API retrieves a list of created scenes, useful for implementing a scene list.
- It requires the
X-XRCLOUD-API-KEY
for authentication and the ProjectID
as a mandatory parameter.
- Pagination can be managed using
take
and skip
parameters.
- You can filter the list by
name
or creator
. To fetch a single scene, append the sceneId
to the endpoint:
- To fetch a specific Scene, append the
SceneID
to the end of the URL:
https://api.xrcloud.app/api/scenes/{sceneId}
3. [Update] Save Scene
- Scene saving is handled within the Spoke editor, so no separate update API is provided.
4. [Delete] Remove Scene
curl -X DELETE "<https://api.xrcloud.app/api/scenes/{sceneId}>" \\
-H "X-XRCLOUD-API-KEY: {YOUR_API_KEY}"