API – Retrieve a Product 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 here. Note: In the following guide and aforementioned documentation, you will see referenced in numerous Endpoints something called a Client. This refers to the folders one can create on the Platform within an Organization. The Client nomenclature is a legacy reference being replaced with Folder. These will be referenced as Client / Folder in all guides.

A common use of the API is to retrieve specific Product’s 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 Products, including directly using its UUID or executing a search using a variety of parameters to filter the results. You can view our guide on Product searches here.

There are two options available when attempting to retrieve a Product 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 a Product with its’ UUID you must first authenticate. For a more detailed look into the authentication steps, view this guide.

Authentication Steps Summary

Log in using an Authentication Key or email / password.
- Returns an x-auth-token in the Response Headers.
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.
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.
Retrieve a list of Clients / Folders and store the needed UUID.
- Pass the x-auth-token in the Request Headers.
- This step can be skipped if the Client / Folder UUID is already stored locally.
Generate a Refresh Token for the Client / Folder (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 Product’s UUID to retrieve its information:

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 Product, including Organization and Client / Folder slug. These slugs are obtained either by retrieving the Organization and Client / Folder information via the Admin API or from the URL of the Client / Folder itself when viewing it on the platform. The URL of any given Client / Folder 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 Product’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 a product 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 Product’s page on the Platform and copy it from the Product ID field in the Product’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 Product by UUID (Admin) Collection

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

Retrieve Product by UUID (Public) Collection

Resources