Overview: System Surveyor API
System Surveyor offers the ability to exchange certain data from the System Surveyor platform with other third-party applications via an Application Programming Interface (API).
The System Surveyor interface utilizes a RESTful API approach. The general scenarios contemplated for this use case include:
- A user logs into a third-party application where the user may view or edit certain information retrieved from System Surveyor in real time. Shared information edited by this user in the third-party application could also update information in System Surveyor, depending on the implementation.
- A user logs into System Surveyor and can view and edit certain information retrieved from a third-party system in real-time.
Below is a high-level description of the information made available for transfer via the System Surveyor API. The response status will indicate if a request was successful, and all responses will be in the JSON format. The API authentication will be linked to a System Surveyor Account Admin User configured in the System Surveyor platform. Any site or edit restrictions applied within the System Surveyor platform to the Account Admin User will be enforced by the API. A throttling mechanism may limit the number of requests made within a specific time interval.
Use of the System Surveyor API requires and is subject to an API Use Agreement. System Surveyor reserves the right to discontinue API access to the platform for non-compliance with the API Use Agreement or if the company determines that such use is negatively impacting system performance, or for system maintenance.
API is only available on Enterprise, Corporate, Manufacturer and Campus Complete plans.
To read more on plan features that include the API, visit the pricing page.