Access to SYNCHRO Perform APIs is governed by a number of considerations. To maintain integrity, performance and security (due to the sensitive nature of the data captured ), we require certain information before  API Tokens are provided for SYNCHRO Perform projects. The API endpoints are primarily designed for two-way interactions, and automation in integration of key entities and data. It does not provide transactional, analytical and reporting data; for large aggregate and transactional datasets, we recommend using API Dataclips. 

API Access Pre-requisites

Before applying for API access, the following criteria: should be confirmed within your project / organisation 

• Commercial Sensitivity: Project data may be commercially sensitive. The requestor should ensure that you have appropriate commercial permissions from your organisation .

• Project Contact: Bentley retains records for all support requests from users, for audits proposes.

• System Load: Some API calls may result in considerable load on the system. If you have large data requirements (two-way) please ensure you outline these requirements in the support request.

To ensure proper usage and security, users should provide:

• A detailed use case and/or workflow they intend to achieve or automate.

• A thorough review of the API documentation which can be found via your SYNCHRO Perform project -   https://{company}.e7.site/api

API Design and Limitations

SYNCHRO Perform API are tailored mainly for 2-way interactions. The following should be considered before raising a support request:

• Usage for Analytics: Tokens for large/demanding applications, especially Analytics, are not usually provided. For users wishing to utilize data for Analytics, refer to Dataclips.

• Token Issuance: All requests are reviewed due to the concerns listed above. It is essential to provide sufficient background on your application's purpose and requirements.

• Performance Concerns: Misuse of specific API endpoints can result in performance issues for end-users on your project.

Suggested Courses of Action

• Read/Write Operations: If your intended use involves both reading and writing data, submit a support request with a clear outline of the workflows you're planning to automate or integrate. Upon review, we will issue the necessary client token.

• Read-only Bulk Operations: If you're primarily looking to automate bulk read-only operations, we recommend using  Dataclips as a more efficient and appropriate solution.

To request the API Client Token and have it provisioned for your project, raise a support request via the Support Portal and use the template below

If you have further questions or require assistance, please add these to the support request.

Example Service Request

Project URL: https://{company}.e7.site/projects/1

Project Contact: Joe Bloggs (Commercial Manager)
Workflows/Reason/Requirement:

• Automate activity/schedule imports from P6/Azure Datalake.
• Synchronise Users from our ERP/HR systems and ensure resources are loaded appropriately.
• Start activities with hours booked (but not started).
• Flag inactive activities (started but with no hours booked in a long time).
• Automate progress uploads.
• Data validation (for example, one field needs to relate to another in a specific way).

Specific Platform Integrations: Azure, ERP, SAP and JDE

Interval/Frequency Requirements: We have a large project, where large schedules from multiple sites will be loaded everyday. This includes all the tasks, budgets and resources (people, equipment, materials). Our datasets also will require high-resolution uploads from our Document Control system to be uploaded to Activities in SYNCHRO Perform