Our API for Trimble Viewpoint Vista™ is perfect for bi-directional data flow. Enjoy unparalleled flexibility, control, security, and speed when it comes to accessing, leveraging, and syncing your data.
Create API connections to virtually any other application that your company uses.
The API is organized to follow the module structure in Trimble Viewpoint Vista™. We’ve connected over 90% of all endpoints available.
Our powerful logic engine allows for complete data flow customization between Trimble Viewpoint Vista™ and your connected applications.
The Data Xchange API for Trimble Viewpoint Vista is a REST API. Our API has resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Utilizing the API in our staging environment will not affect your live data - so long as it is tied to a test Vista instance. The set of API keys you utilize to authenticate a request, as well as the API base URL will determine what environment is used.
All endpoints with a multi-record response support pagination. Pagination allows our services to provide the optimal experience for our customers. By implementing pagination in your application, you can minimize response times for requests and generally improve the end-user experience.
We use forward-only paging with a continuation token strategy. The API limits multi-record GET responses to 1000 records, although the caller can provide a lower limit using the limit parameter. NOTE: The API may return fewer records than the limit value. Examination of the continuation token and next properties is needed to determine if additional records exist. As long as there is a next URL value you should continue making GET calls to ensure all data is read.
The Data Xchange API for Trimble Viewpoint Vista uses API keys to authenticate requests. Someone from our customer success team will provide you with your API keys.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in areas accessible to other parties.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
A Comprehensive API Designed Specifically for Trimble Viewpoint Vista
Included Modules
Things to Know Before Starting
The Data Xchange API for Trimble Viewpoint Vista is organized to provide a RESTful, yet logical view of the data points that exist within their respective Vista modules.
To get started, you’ll have to install the Xchange Agent - a lightweight windows service that can be installed in the Customer's environment (including the ViewpointOne environment), to broker a highly secure connection to any single Customer's instance of Vista.
The Xchange Agent operates over HTTPS; encrypts data at rest, and in motion; and is responsible for receiving instructions from Data Xchange, executing those instructions against the database, and then streaming the results back to the platform for processing.
The Xchange Agent is authorized via credentials that would be provided during onboarding. The service is set up to limit permissions based on expected use.
The Data Xchange API for Viewpoint Vista is composed of two key features: a queueing method and a caching layer.
The Action Queue ensures actions are processed against the Vista database. Think of any action in which new data should be created (e.g. create a new employee record), updated (e.g. change the employee's address), or deleted (e.g. set the employee status to 'terminated'). Actions are presented as POST or PUT endpoints to provide access and control to create or modify data within a certain module or data endpoint.
The caching layer is used for performance, state management, and data change discovery. The integration platform has a replication service that will routinely poll for data changes in the Vista database in order to replicate those changes to the cache so that they are available to the API service. Data in the cache is presented as a GET endpoint to provide access and control to read data within a certain module or data endpoint.