Resources

API – Retrieve an Asset with UUID

API Base URL: https://api-platform.vntana.com

For a collection of all Endpoints in our Admin API, view the documentation here. To view the collection of Public Endpoints, view the documentation hereNote: In the following guide and aforementioned documentation, you will see referenced in numerous Endpoints something called a Client. This refers to the workspaces one can create on the Platform within an Organization. The Client nomenclature is a legacy reference being replaced with Workspace.

A common use of the API is to retrieve specific Workspaces and their information for a multitude of reasons, including updating it, generating an iFrame for it, or checking its status. There are a couple different methods available to retrieve Assets, including directly using its UUID or executing a search using a variety of parameters to filter the results. You can view our guide on Asset searches here.

There are two options available when attempting to retrieve an Asset directly via its UUID, one through the Admin API and the other through the Public API. As with all Admin API commands, in order to get an Asset with its’ UUID you must first authenticate. For a more detailed look into the authentication steps, view this guide.

  1. Log in using an Authentication Key or email / password.

    • Returns an x-auth-token in the Response Headers.

  2. Retrieve a list of Organizations and store the needed Organization’s UUID.

    • Pass the x-auth-token from Step 1 in the Request Headers.

      1
      { ‘x-auth-token’ : ‘Bearer ‘ + x_auth_token }
    • This step can be skipped if the Organization UUID is already stored locally.

  3. Generate a Refresh Token for the Organization.

    • Pass the x-auth-token from Step 1 in the Request Headers.

      1
      2
      3
      4
      {
      ‘x-auth-token’ : ‘Bearer ‘ + x_auth_token
      ‘organizationUuid’ : ‘string’
      }
    • Returns the Refresh Token as the Response Header x-auth-token.

  4. Retrieve a list of Workspaces and store the needed UUID.

    • Pass the x-auth-token in the Request Headers.

    • This step can be skipped if the Workspace UUID is already stored locally.

  5. Generate a Refresh Token for the Workspace (Organization Admin / Owner users must skip this step).

    • Pass the Refresh Token from Step 3 in the Request Headers with the Organization and Client UUID’s.

      1
      2
      3
      4
      5
      {
      ‘x-auth-token’ : ‘Bearer ‘ + refreshToken,
      ‘organizationUuid’ : ‘string’,
      ‘clientUuid’ : ‘string’
      }
    • Returns the Refresh Token as the Response Header x-auth-token.

Once properly authenticated, the following endpoint can be used with the Asset’s UUID to retrieve its information:

1
2
3
Method: GET
Endpoint: /v1/products/some-product-uuid
Headers: { ‘x-auth-token’ : ‘Bearer ‘ + refreshToken }

The Public API endpoint does not require any authentication before you can use it, you just need to know the necessary information for the endpoint to find the Asset, including Organization and Workspace slug. These slugs are obtained either by retrieving the Organization and Workspace information via the Admin API or from the URL of the Workspace itself when viewing it on the platform. The URL of any given Workspace is https://platform.vntana.com/organization-slug/client-slug. The endpoint is as follows:

Do note that the base URL is different than that of the Admin API. Now with the Asset’s information, it can be integrated as you see fit, including the construction of an iFrame for it or adding it to a Configurator. For more information, check out our guides on our iFrame and Configurator.

You can test the Admin API process using the below Postman collection. This will require that you know the UUID of an Asset beforehand (you can use the search endpoint but that defeats the purpose of this endpoint as it would already return the information you need), to get this simply visit the Asset’s page on the Platform and copy it from the Asset ID field in the Asset’s details. For more information on using our Postman collections view this guide but generally for these to work you will need to set the necessary global variables for the collection as well as choose which authentication to use (key or email / pass). This can either be run in one execution, or to run each endpoint individually you will need to activate the deactivated headers and fill in the necessary variables for each endpoint.

Search Asset by UUID (Admin) Collection

To test the Public endpoint, you can use the following Postman collection.

Retrieve Asset by UUID (Public) Collection

Accelerate Your
Digital Transformation

Learn how our platform can automate your 3D process.

Tap the magnifying glass to the left of your screen to search our resources.