API Data Provider - Online Help

Connecting to Ubiregi

The Ubiregi API uses a token-based authentication.

Using Token Authentication

Your Ubiregi API Token and MenuId are required to create a connection to Ubiregi. API Token can be generated in the Ubiregi system integration page https://ubiregi.com/a/account/apps/developer/. Once you have obtained it, set it in the ProfileSettings API Key connection property. And You can find MenuId at your Ubiregi Menu Page URL "https://ubiregi.com/a/setting/menus/{MenuId}". ex. 12345

Example Connection string

Profile=C:\profiles\Ubiregi.apip;ProfileSettings='APIKey=your_api_token;MenuId=12345;'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Api Key you get from your Ubiregi account.
MenuId Set this to your MenuId. You can find MenuId at your Ubiregi Menu Page URL "https://ubiregi.com/a/setting/menus/{MenuId}". ex. 34072.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0