Documentation

Below you will find a growing collection of documentation related to VNTANA’s software offerings.

Rest API Documentation V1.0

Rest API Quick Start Guide

This guide will give you a brief overview of how to use the VNTANA Admin API in order to login to our Platform, authenticate your account, and retrieve your organizations, clients, products, and any additional information about your products, such as tags and locations. For a more comprehensive overview of our API, please check out our detailed API Documentation here.

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

1. Login to the VNTANA Platform

  • Use the following endpoint to authenticate
Method: POST
Endpoint: /v1/auth/login
Sample Request Body: { “email”: “[email protected]”, “password”: “YourPassword1” }
  • On successful authentication, a temporary user authentication token, X-AUTH-TOKEN, will be returned in the Response Headers.

2. Retrieve your Organizations List

  • After authentication, you can retrieve the list of your Organizations using the X-AUTH-TOKEN Response Header from Step 1.
Method: GET
Endpoint: /v1/organizations
Headers: { “x-auth-token”: “Bearer ” + token }
  • The token is the X-AUTH-TOKEN value retrieved after logging in. Don’t forget to add “Bearer ” before your token value.

  • The response has the list of all the Organizations in your Platform account, including important details such as the name, role, slug, and uuid of each Organization.

3. Authenticating a specific Organization (Retrieve the Refresh Token)

  • In order to authenticate a specific Organization to see the Clients and Products for that Organization, you must retrieve the Refresh Token, which is an Organization-specific token.

  • Pass the X-AUTH-TOKEN, as well as the UUID of the Organization you would like to view, as headers in the following endpoint:

Method: POST
Endpoint: /v1/auth/refresh-token
Headers: { “x-auth-token”: “Bearer ” + token, “organizationUuid”: uuid }
  • The token is still the same X-AUTH-TOKEN retrieved after successfully logging in, and the Organization UUID can be found from the list of Organizations returned in Step 2.

  • On successful authentication of the selected Organization, you will receive another X-AUTH-TOKEN Response Header. This is the Refresh Token for this Organization. Please keep in mind that the X-AUTH-TOKEN from Step 1 is different from the one described in this step (Step 3).

  • You can now access your Clients and Products for this Organization!

4. Retrieve Clients List for selected Organization

  • Pass the Refresh Token retrieved from the previous step (Step 3) to the following endpoint in order to get your list of Clients for the selected Organization:
Method: GET
Endpoint: /v1/clients/client-organizations
Headers: { “x-auth-token”: “Bearer ” + refreshToken }
  • A successful response will return the list of Clients for the selected Organization, as well as the name, role, slug, uuid, and other details for each Client.

5. Retrieve Products for Selected Client

  • In order to view the Products for a single Client, use the following endpoint:
Method: POST
Endpoint: /v1/products/clients/{clientUuid}/search
Sample Request Body: { “page”: 1, “searchTerm”: “string”, “size”: 10, “status”: “LIVE” }
Headers: { “x-auth-token”: “Bearer ” + refreshToken }
  • The list of Products retrieved can be filtered in a number of ways, including by Search Term, Tags, Locations, and Conversion Statuses. Please reference the linked full API Documentation above to see the different parameters accepted in the Request Body for this endpoint.

  • The “x-auth-token” header here also requires the Refresh Token (Organization-specific token) from Step 3.

6. Retrieve Locations

  • Use the following endpoint to get the list of Locations created under a specific Client:
Method: POST
Endpoint: /v1/locations/search
Sample Request Body: { “clientUuid”: clientUuid, “page”: 1, “size”: 5, “searchTerm”: “string” }
Headers: { “x-auth-token”: “Bearer ” + refreshToken }
  • The UUID for the selected Client must be passed in the request body.

  • Locations can be filtered by page, size, search term, and date. Please see the full API Documentation for a complete list of search filters.

  • The Refresh Token from Step 3 must also be passed as an “x-auth-token” header.

7. Retrieve Tags

  • Use the following endpoint to get the list of Tags created under a specific Client:
Method: POST
Endpoint: /v1/tags/search
Sample Request Body: { “clientUuid”: clientUuid, “page”: 1, “size”: 12, “searchTerm”: “string” }
Headers: { “x-auth-token”: “Bearer ” + refreshToken }
  • The UUID for the selected Client must be passed in the request body.

  • Tags can be filtered by page, size, and search term.

  • The Refresh Token from Step 3 must also be passed as an “x-auth-token” header.

Additional Notes

  • In order to authenticate another Organization, the Refresh Token for that Organization must be retrieved (repeat Step 3). Simply pass the temporary user authentication token from Step 1, as well as the UUID of the Organization you wish to view (retrieved from Step 2), into the Refresh Token endpoint (Step 3). On success, you will be able to see the Refresh Token (Organization-specific token) for the Organization you have selected to view.

  • Once you have the new Refresh Token, you can repeat Steps 4-7 in order to retrieve the Clients, Products, Locations, and Tags for that Organization.

3D Webviewer

Coming Soon!