logo

Abound REST API

The Abound API lets you access data that has been uploaded to the Abound cloud using the SDK for iOS.

The API is organized around REST. The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The Use the REST API tutorial gives an introduction to accessing the API with Node.js.

Note: the API is in beta so expect changes.

Please send any feedback or suggestions to feedback@aboundlabs.com.

Authenticate

To access the API you must authenticate using an API key generated for your Abound account. If you don't already have an Abound account then sign up at dashboard.aboundlabs.com.

Each API key only has access to data collected using its associated app.

Authenticate app

post /app/authenticate

API server

https://api.aboundlabs.com/v1/app/authenticate

Authenticate by sending your app's secret API key.

Request Body schema: application/json

A JSON object containing the API key.

apiKey
required
string

API key

Responses

200

Successfully authenticated. The session ID is returned in a cookie named abound-app-session. You need to include this cookie in subsequent requests.

422

Invalid request

500

Internal error

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "message": "Successfully authenticated."
}

Log out of session

post /app/logout

API server

https://api.aboundlabs.com/v1/app/logout

When you're finished using the API, log out of the session.

Responses

200

OK

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Scans

Scans are the 3D triangular mesh data, including rendering.

Get all scans

get /scans

API server

https://api.aboundlabs.com/v1/scans

Use this endpoint to retrieve data about the scans that your users have saved using the iOS SDK.

Authorizations:
cookieAuth

Responses

200

OK

401

Unauthorized

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Get a scan

get /app/scans/{scanId}

API server

https://api.aboundlabs.com/v1/app/scans/{scanId}
Authorizations:
cookieAuth
path Parameters
scanId
required
string

Unique ID of the scan to get

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not found

422

Invalid request

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}