• XRCLOUD를 이용한 자체 공간 관리 도구를 개발하기 위한 CRUD API에 대한 설명입니다.

I. Scene

1. [생성] Spoke 에디터 호출

• API : https://api.xrcloud.app/api/scenes/get-creation-url
• API문서 : https://api.xrcloud.app/docs/ko/#tag/scene/operation/GetScenes
• 설명
  • 씬의 추가는 Spoke에디터의 접속 URL을 불러오는 API입니다.
  • 인증은 동일하게 XRCLOUD-API-KEY를 요구하며 입력 값으로는 Creator와 Callback 값을 셋팅할 수 있습니다.
  • Creator는 관리자의 계정별, 혹은 유저별로 나누고 싶은 경우 해당 값을 설정하여 보내면 사용자 필터처럼 사용됩니다. 서비스 내부적으로 관리되고 있는 uuid를 전달해주셔도 됩니다. Create할때는 Spoke에디터의 myAsset을 구분됩니다. creator가 지정되지 않으면 Admin이 제작한 것과 동일하게 취급됩니다.
  • calklback은 Spoke 에디터가 끝나고 돌아가는 URL입니다. 편집후, 혹은 편집 중 취소시 복귀되는 URL을 셋팅해주시면 됩니다.

2. [읽기] Scene 리스트 불러오기

• GET API : https://api.xrcloud.app/api/scenes
• API 문서 : https://api.xrcloud.app/docs/ko/#tag/scene/operation/GetScenes
• 설명
  • 생성한 Scene들을 불러오는 API로 Scen리스트를 구현할때 사용됩니다.
  • 인증은 동일하게 X-XRCLOUD-API-KEY를 요구하며, get파라미터로 ProjectID가 필수 값입니다.
  • 리스트에 사용되므로 페이지네이션을 위한 take값과 skip값을 셋팅할 수 있습니다.
  • nam은 씬의 제목, creator는 씬 생성시 할당되었던 유저로 구분해서 리스트를 불러올 수 있습니다.
  • 한개의 Scene을 불러오는 API는 뒤에 SceneID를 붙여주면 됩니다. https://api.xrcloud.app/api/scenes/{sceneId}

3.[수정] Scene 저장

• Scene저장은 Spoke에디터에서 진행 되므로 별도의 수정 API를 제공하지는 않습니다.

4. [삭제] Scene 삭제

• SceanId로 Scene을 삭제합니다.
• DELETE API :https://api.xrcloud.app/api/scenes/{sceneId}
• 설명 : https://api.xrcloud.app/docs/en/#tag/scene/operation/RemoveScene

curl -X DELETE "<https://api.xrcloud.app/api/scenes/{sceneId}>" \\
     -H "X-XRCLOUD-API-KEY: {YOUR_API_KEY}"