This is just to demonstrate the easy API structure you will get. For API Credentials, URL and User details please contact us after you Sign-Up for a developer-account over the profile!
\nThis documentation guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests for TekTuşla 3D Reconstruction.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🚀 Get Started","slug":"get-started"}],"owner":"36490094","collectionId":"9420efb3-31e1-40f0-b301-2bbd6bc4a941","publishedId":"2sA3duFY9V","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-28T20:21:44.000Z"},"item":[{"name":"Get User API Key","id":"d3a873a3-1f50-4e5f-a9d8-953f064827c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"EMAIL","type":"text"},{"key":"password","value":"PASSWORD","type":"text"}]},"url":"https://domain.com/get-api-key","description":"With the user email and password you can get the api-key of the user to set environment variable if it is changed by the sys-admin or user is newly created.
\n","urlObject":{"path":["get-api-key"],"host":["https://domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3a873a3-1f50-4e5f-a9d8-953f064827c1"},{"name":"Server Status","id":"bc53fd7c-f278-429f-8797-8d8c64ce94e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://domain.com/ping","description":"If the server is down the ping endpoint will stop working. Pong message will indicate server is up and running.
\n","urlObject":{"path":["ping"],"host":["https://domain.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc53fd7c-f278-429f-8797-8d8c64ce94e9"},{"name":"Scan Status","id":"f4516041-42e6-44e8-8fa7-6d0fbf7511de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"folder_name\": 8\n}","options":{"raw":{"language":"json"}}},"url":"https://domain.com/scanstatus?api_key=YOUR_API_KEY","description":"Body Raw Json \"folder_name\" indicates the Scan ID on portal.tektusla.com
\nStatus of the scan can be
\nuploading
\nuploaded
\nprocessing
\npreprocessed
\ncomplete
\nfailed
\nBody Raw Json \"folder_name\" indicates the Scan ID on portal.tektusla.com
\nThis endpoint returns a zip file of OBJ, MTL and Texture for the 3D Model
\n","urlObject":{"path":["checkmodel"],"host":["https://domain.com"],"query":[{"key":"api_key","value":"YOUR_API_KEY"}],"variable":[]}},"response":[],"_postman_id":"9167fd8f-0bb4-42d1-93e2-ee9e3d992b60"},{"name":"Check Model GLB","id":"11f3658a-52f0-4a92-bbc4-67a52294598f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"folder_name\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://domain.com/checkmodelglb?app_key=YOUR_API_KEY","description":"If the scan is not \"published\" and made publicly accessible from the Web-App this endpoint will not return any model
\nBody Raw Json \"folder_name\" indicates the Scan ID on portal.tektusla.com
\nThis endpoint is specifically for portal.tektusla.com where the WebGL Renderer is easier to configure and control with GLB files.
\n","urlObject":{"path":["checkmodelglb"],"host":["https://domain.com"],"query":[{"key":"app_key","value":"YOUR_API_KEY"}],"variable":[]}},"response":[],"_postman_id":"11f3658a-52f0-4a92-bbc4-67a52294598f"},{"name":"Upload Images","id":"066adbf8-b026-4282-8470-28e5715619c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","type":"file","value":null},{"key":"data","value":"{ \"userID\": \"1234\", \"projectName\": \"Scan Name\"}","type":"text"}]},"url":"https://domain.com/upload?api_key=YOUR_API_KEY","description":"Creating new scan by uploading array of images to the user account. This will automatically update the Web-App to show the uploaded scan as well.
\nThe data section is a json and the userID is a string. Provided projectName will also be visible in the Web-App
\n","urlObject":{"path":["upload"],"host":["https://domain.com"],"query":[{"key":"api_key","value":"YOUR_API_KEY"}],"variable":[]}},"response":[],"_postman_id":"066adbf8-b026-4282-8470-28e5715619c8"},{"name":"Upload Video","id":"db2600f8-27f0-43bd-98f5-e630c4d108b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","type":"file","value":null},{"key":"data","value":"{ \"userID\": \"1234\", \"projectName\": \"Postaman Test\"}","type":"text"}]},"url":"https://domain.com/uploadVideo?api_key=YOUR_API_KEY","description":"Only 1 video should be uploaded at a time.
\nCreating new scan by uploading a video to the user account. This will automatically update the Web-App to show the uploaded scan as well.
\nThe data section is a json and the userID is a string. Provided projectName will also be visible in the Web-App
\n","urlObject":{"path":["uploadVideo"],"host":["https://domain.com"],"query":[{"key":"api_key","value":"YOUR_API_KEY"}],"variable":[]}},"response":[],"_postman_id":"db2600f8-27f0-43bd-98f5-e630c4d108b4"}],"event":[{"listen":"prerequest","script":{"id":"10e846c3-89e0-49e6-b7fa-d3d9b0b30183","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79d05fa7-0fc6-42a8-b52b-bd75a66d62d1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://domain.com","type":"default"},{"key":"portal_url","value":"https://domain.com","type":"default"},{"key":"user_id","value":"1234","type":"default"},{"key":"email","value":"EMAIL","type":"default"},{"key":"password","value":"PASSWORD","type":"default"},{"key":"api_key","value":"YOUR_API_KEY","type":"default"}]}