Set Up the API Service Account

The API Service account facilitates Project Center connectors. You will need to create and configure a new API Service account to complete connector setup. Please see the detailed requirements for the account below.

1.     Create a NEW domain account for the API to use.

●        Do NOT use the Azure AD service account or the Newforma service account.

●        It is best to set up a new account for this purpose.

If you are using multiple Project Center Connectors, it is recommended that you create a separate API service account for each connector.

Account requirements:

●        Name the account "Newforma API" or something similar so it is easy to distinguish its purpose. If you are setting up multiple service accounts, consider including identifying information in the name to easily distinguish them (i.e., including "BIM 360" in the account used for the BIM 360 connector.

●        The account requires an email address but does not require a mailbox.

●        The API Service account must have read/write/modify permission to your Newforma server discs and your project folders on the file server. The API writes temporary files to the Project Center Server and needs to read and write record copies of file transfers in the project folders.

●        The API Service account must be assigned a Newforma user license.

●        The API Service account must be assigned Global Admin privileges in Newforma Project Center Administration.

●        The API Service account must be assigned Contract Manager privileges in Newforma Project Center Administration, as it needs to create RFIs and submittals.

2.     Log into a Windows computer using the API Service account. The computer must have the Newforma Project Center client installed. Open Project Center and complete the Newforma profile for the account.

3.     Make sure that the API Service account is synced to Azure AD.

If the account was created recently, you may need to force sync the account.

4.     Once the API Service account is set up, you will need to email support@newforma.com with the API Service account email address to enable the generation of the Service Access Key for your connector.

Additional Information

●        While the recommendation is to create a separate API service account for each connector, it is possible to use the same account for multiple connectors.

●        If you do not remember the Access Key and Secret for the existing API service account and generate a new one, you will break any connectors currently using that account.