Integration scopes are a crucial aspect of the T-Gate Partner API, allowing companies to control which data third-party applications are permitted to access. These scopes are defined by each company and are specific to the integration between the company and the partner application. By setting integration scopes, companies can ensure that only the necessary data is shared with external applications, enhancing security and data privacy.
For more detailed explanation on integration scopes and how they operate, please refer to the Partner API → Integration Scopes Guides.
Model Attributes
a single integration scope represents a relation between a brand, branch and a menu that the partner can access
| Attribute | Description | Type |
|---|---|---|
| id | the unique identifier of that table entity | Integer |
| brand_id | the id of the brand which a partner can access | Integer |
| branch_id | the id of the branch linked to that brand that a partner can access | Integer |
| menu_id | the id of the menu linked to that branch that a partner can access | Integer |
Integration ScopesIntegration scopes inform partners about which entities they have access to and notify them whenever a change occurs.
Deleting an integration scope means that a partner no longer has access to that data.
Conversely, creating new integration scopes indicates that there are additional data available for the partner to fetch.