This article provides a summary of the steps and information required to get started with the OpenGround REST API.
We also recommend reviewing the Development Concepts video located here.
To use the OpenGround API, you must have an “i5” cloud instance. To verify your cloud services level, please have your Bentley Administrator check your cloud services subscription under Entitlements in Bentley Connect. Please contact your account manager or our sales team if you need to upgrade your cloud subscription.
Your organization must be a member of the BDN to use the OpenGround API. The BDN is free to join for existing Bentley users for internal (non-commercial) development purposes. Find out more here.
We can provide a “sandbox” cloud for building and testing your application outside of your production environment. To request a sandbox cloud, please contact support or your OpenGround Implementation Manager.
The OpenGround API uses OAuth 2.0 authentication/authorization. We support both Client Credentials (Machine) and Authorization Code with PKCE (User Login) authentication. Find out more here.
Depending on the authentication method you need to use, you may need to request a Client ID & Secret. Find out more here.
Most endpoints will require you to specify your cloud ‘Region’ (within the request url) and ‘Instance ID’ (within the request headers). Find out more here.
We have a .net/C# SDK. Please see our .net SDK Reference Guide for more information. Alternatively, you can interact directly with the REST API using the programming language of your choice.