Company Integrators
A company integrator is a system user, and is created in the Genius Portal. A franchisee or third-party uses its key identifier (ID) and secret to get an API access token for the subset of assigned sites within the company
A role must be assigned to the company integrator. The assigned role grants access to many APIs, which are governed by the assigned permissions within the role. The assigned role determines what the company integrator can do and only roles and permissions granted by the individual company can be used. The roles are defined and managed within Genius Portal, and are the same roles that are assigned to Genius Portal users.
The company integrator's site assignment can be managed by explicit selection or through user groups.
Permissions
→ →
The Company Integrator module has the following permissions:
Permission | Name | Description |
|---|---|---|
View | Company.Integrator.View | View the list and the edit form (read only) |
Add | Company.Integrator.Add | Create company integrators |
Edit | Company.Integrator.Manage | Edit and save company integrators |
Delete | Company.Integrator.Delete | Delete company integrators |
Company Integrators List
From the Company Integrators List:
View a list of all existing company integrators.
Search and sort company integrators.
The Company Integrators List displays:
List Header | Description |
|---|---|
Name | The company integrator name. The name must be unique for an individual company, but can be used one time each across different companies. |
Roles | The roles assigned to the company integrator. A minimum of one role must be assigned to the company integrator for it to access the API. |
Create Company Integrator
→ →
From the Company integrators homepage, select Create Integrator. The following table introduces the sections of the Company Integrators editor.
Section | Description |
|---|---|
General settings about the company integrator including the name, key ID, secret, and the duration it will be valid. From General, copy the key ID and secret for use. | |
Assign roles to the company integrator. A minimum of one role must be assigned. | |
Add user groups to the company integrator. | |
Add sites to the company integrator. The company integrator reaches assigned sites only, including sites associated with assigned user groups. |
General
To define general settings for a company integrator:
From the menu pane on the left, select General.
From the General page of the company integrator record, define the following:
Settings
Description
Integrator Name
The integrator name must be unique when used within one company, but can be reused one time each across different companies.
Duration
Select the length of time in days from the dropdown, during which the generated token will be valid. The default value is 21.
From the General page, save the Key ID value. Select
to copy the Key ID value.From the General page, save the Secret value. Select
to copy the Secret value.Importante
The Secret value can be viewed only during the Company Integrator creation process. It is recommended that this information is copied before saving the form, as it is unable to be viewed after.
From the General page, select Copy Sample Token Generate Request to copy a sample token request body.
Roles
Importante
A minimum of one role must be assigned to the company integrator.
To define availability settings for a company integrator:
From the menu pane on the left, select Roles.
From the Roles page, select Add Role.
From the Add Roles popup, select all applicable company roles.
Nota
The Company Administrator role cannot be assigned to the company integrator, and the user cannot assign roles with permissions not provided to them.
From the lower right of the Add Roles popup, select Select Role.
The People.AllSitesAccess permission does not apply to company integrators. Sites must be assigned to the company integrator directly or through user groups. To view the gold site, the role must have GoldSite.View permissions.
A role assigned to a company integrator cannot be deleted.
User Groups
To add user groups to the company integrator:
From the menu pane on the left, select User Groups.
From User Groups, select Add User Groups.
From the Add User Groups popup, select the applicable user groups.
From the lower-right of the Add User Groups popup, select Select User Group.
Sites
To add sites to the company integrator:
From the menu pane on the left, select Sites.
From Sites, select Add Site.
From the Site Selector popup, select the applicable sites.
From the lower-right of the Site Selector popup, select Select Site.
From the upper-right of the New Company Integrator page, select Save.
Edit Company Integrator
To edit a company integrator:
From the Company integrators homepage, select the 3-dot menu on the company integrator row.
From the 3-dot menu, select Edit Integrator.
From the Company Integrator page, edit the following as needed:
From the upper-right of Edit Company Integrator page, select Save.
Delete Company Integrator
To delete a company integrator:
From the Company integrators homepage, select the 3-dot menu on the company integrator row.
From the 3-dot menu, select Delete Integrator.
Nota
Alternatively, the company integrator can be deleted through Edit Integrator:
From the Company Integrator List, select the 3-dot menu and select Edit Integrator.
From the upper-right of the Company Integrator page, select the Save dropdown.
From the Save dropdown, select Delete Integrator.
The deleted integrator:
Cannot generate new tokens and its existing tokens are blocked.
Cannot make any further requests against the APIs.
Is soft-deleted (
is_active = false).
Endpoint and Request Body
For the final implementation, use POST /v1/company-integrator/access-token with no auth header and this body:
{
"key": "{{key_id}}",
"secret": "{{secret_key}}",
"company_id": "{{company_id}}"
}For additional information, see Getting a Company Integrator Token.