Skip to content

API Access

In order to consume the docCentrum API, you must create an Application Registration in Microsoft Entra ID.

Name the App Registration something relevant to how the API will be consumed, e.g. docCentrum Power Automate Connector.

Keep it as Accounts in this organizational directory.

Often, the platform being used to consume the API will require a Redirect URL. With Power Automate, this is generated after the connector is created (as it's unique to the connector). You may have to revisit the Application Registration after the connector is created.

When you create the App Registration, give it permission to consume the docCentrum API API. To do this follow these steps:

  • After you register your Application, go to API Permissions
  • Click Add a permission
  • From the tabs under Select an API, choose the APIs my organization uses
  • Search for docCentrum from the list
  • Choose the appropriate docCentrum App, docCentrum API for Premium features, or docCentrum Lite.
  • Select Delegated Permissions
  • Select the scopes admin_tasks and user_impersonation
  • Click Add permissions

You may then need to Grant admin consent by clicking the button at the top of the list of permissions.

Finally, create an Client Secret with a standard 2 year expiry and keep this for later use.

You may then consume the docCentrum API by using this Application from your solution.

If you are fulfilling this as a service request, then pass the App ID and the Client Secret back to the requestor, who may come back to you with a request to add a Redirect URL to the app registration.

Scopes

These are the scopes that are available for apps accessing the docCentrum API:

Scope Admin consent required Description
Tasks.My.Manage No Manage the current logged in user's tasks
Tasks.Admin Yes Manage all users tasks
user_impersonation No Log in as the current user

Authentication in Power Automate

If you are consuming this from Power Automate/Power Apps and you need to use the Custom Connector, you'll have to create a Client Secret.

When setting up Authentication in Power Platform, use these parameters:

Note

The Resource URL and Scope values differ depending on the Service Tier (Lite or Premium). Ensure you enter the correct value for the service tier in use.

  • Authenticate Type: OAuth 2.0
  • Identity Provider: Azure Active Directory
  • Client ID: The Application ID of the app you registered above
  • Client Secret: An app secret you created in the app above
  • Authorization Url: https://login.microsoftonline.com
  • Tenant ID: The ID of your tenant

If you are on docCentrum Premium, use these values for Resource URL and Scope:

  • Resource URL: api://fc0ecb91-d846-46d0-a363-4f97c69db711
  • Scope: api://fc0ecb91-d846-46d0-a363-4f97c69db711/user_impersonation

If you are on docCentrum Lite, use these values for Resource URL and Scope:

  • Resource URL: api://5b0479de-89c3-4c7a-aa5f-393001579763
  • Scope: api://5b0479de-89c3-4c7a-aa5f-393001579763/user_impersonation

Power Automate will then generate a Redirect URL once the connector is saved. Add this to the Redirect URLs for the App registration you created above.

GCC

If you're using GCC, use this Authorization URL: https://login.microsoftonline.us.