Skip to main content

Accelero App Integration

The Accelero App integration connects ACCELERO to the Accelero App application, aimed at residents and unit users. Through the app, a person can register, obtain their access QR Code, and create visitor invitations — and ACCELERO keeps this data synchronized in both directions.

Communication is bidirectional: the app consumes an external API exposed by the plugin (external/acceleroapp/...) to register people, generate QR Codes, and create invitations; and ACCELERO notifies the app about the progress of visits (check-in, entry, and exit) through callback calls.

Availability

This integration is provided as a plugin (acceleroapp) and must be installed and enabled by IONGRADE's technical team. Contact support to check compatibility with your version of ACCELERO.

Compatibility

Current plugin version: 0.2.1 — compatible with ACCELERO 2.16.6, 2.16.7, 2.16.8, and 2.17.0.


What the integration does

With the plugin active, the Accelero App application communicates directly with ACCELERO, which remains the single source of truth for registrations and access.

FeatureWhat happens in ACCELERO
Registering people from the appThe app sends the person's data and ACCELERO creates (or updates) the record, linking it to the default category and the informed unit
Listing people and unitsThe app queries enabled people, units (companies), and available event types
QR Code generationThe app requests a person's access QR Code, in fixed or dynamic version
Visit invitationsThe app creates, cancels, and updates invitations; ACCELERO generates the corresponding visit event
Recurring invitationsThe app creates and removes recurring visit invitations
Visit status notificationOn each visitor check-in, entry, or exit, ACCELERO informs the app about the visit status
Disable personThe app can disable a person in ACCELERO by document
Manual and bulk sendingOperators can send people and companies to the app, individually or in batches
Main benefit

Gives residents the autonomy to register, obtain their own access, and manage visits from their phone, without manual intervention from the front desk, keeping ACCELERO as the central access control system.


Configuration

Navigation path: Settings > Integrations - AcceleroApp

The screen has two tabs: General and Synchronization.

TODO: Add Screenshot

Configuration screen Settings > Integrations - AcceleroApp with the General and Synchronization tabs visible.

General tab

Integration data:

FieldDescription
OperatorACCELERO operator used as the party responsible for the operations performed by the integration (e.g., records created from the app)
Authentication token (APP > Accelero)Token that the application presents to authenticate its calls to ACCELERO's external API
Authentication token (Accelero > APP)Token used by ACCELERO to authenticate the notification calls sent to the application
AcceleroApp URLAddress (endpoint) of the Accelero App application service that ACCELERO calls to notify status

Person category:

FieldDescription
Default category for new residentsCategory automatically assigned to every person registered from the app
Association of new residentsAssociation type (person-company link) applied when linking the new resident to the unit

Visits:

FieldDescription
Default event typeEvent type used when creating visits originated from the app

Others:

FieldDescription
Overwrite data of existing peopleWhen enabled, data sent by the app (name, document, email, phone, photo) overwrites that of an already registered person. When disabled, only new people have their data recorded from the app
Data overwrite

With Overwrite data of existing people enabled, any record made from the app can replace information already existing in ACCELERO. Assess the impact before enabling it in environments with previously reviewed records.

Synchronization tab

Defines the scope of the bulk sending of data to the application.

FieldDescription
Event typesMulti-selection of the event types considered in the synchronization
Person categoriesMulti-selection of the person categories considered in the synchronization

Bulk sending:

The Synchronize data button triggers the synchronization. The process runs in the background, in batches of 100 records, and the operator receives a notification upon completion.

TODO: Add Screenshot

Synchronization tab showing the Event types, Person categories fields and the Synchronize data button.

Bulk sending prerequisites

Synchronization only starts if there is at least one event type and at least one person category selected. It is not possible to start a new synchronization while another is in progress.

Screen buttons

ButtonFunction
BackReturns without saving
SavePersists the configuration
Synchronize dataStarts the bulk sending of people and companies to the app (Synchronization tab)

Manual sending of people and companies

In addition to bulk sending, it is possible to send a specific person or company to the app directly from the entity's edit screen.

Person

In the person record, the plugin adds the Accelero APP section, with the Send data to APP button. When triggered, ACCELERO sends the person's record to the app and stores the returned remote identifier.

TODO: Add Screenshot

Person record (People > Edit) with the Accelero APP section expanded and the Send data to APP button.

Company

In the company record, the plugin adds the Accelero APP section, also with the Send data to APP button, which sends the unit (company) to the application.

TODO: Add Screenshot

Company record (Companies > Edit) with the Accelero APP section expanded and the Send data to APP button.

Individual vs bulk sending

Use the Send data to APP button for one-off cases (a new person or unit). For a complete initial load, prefer the Bulk sending in the Synchronization tab.


External API consumed by the application

The plugin exposes a set of endpoints under external/acceleroapp/..., authenticated by the Authentication token (APP > Accelero). They are consumed by the Accelero App application itself — they are not operation screens in ACCELERO.

OperationWhat it does
List event typesReturns the available event types
List unitsReturns the registered companies (units)
List peopleReturns the enabled people and their units
List people of a unitReturns the people linked to a specific unit
Register personCreates or updates the person, sets the default category, and links them to the unit
Disable personDisables the person by the informed document
Generate QR CodeReturns the person's access QR Code (fixed or dynamic)
Create / cancel invitationCreates or cancels a visit invitation
Create / remove recurring invitationCreates or removes a recurring visit invitation
Update invitation statusUpdates the invitation status (LinkEventoPessoa)
Cross-identification

Each synchronized person, company, and visit stores the corresponding identifier in the app in its metadata (acceleroapp), which allows ACCELERO to locate the right record in subsequent operations (cancellation, status update, etc.).


Invitations and visits

When the app creates an invitation, ACCELERO generates a visit event using the configured Default event type, registers the visitor (creating or updating the record, according to the overwrite option), and associates it with the host resident and the unit.

For visits generated by the app, ACCELERO also produces a virtual card of the QR Code type valid for the same period as the event, enabled as long as the visit and the visitor's link are active.

TODO: Add Screenshot

Visit event created from an app invitation, in Visits / Schedules, showing the visitor, the host, and the unit.

Status notification to the app

ACCELERO notifies the application about the progress of the visit at the following moments:

EventStatus sent to the app
Visitor check-incheckin
Entry passentry
Exit passexit

The distinction between entry and exit uses the controller's channel configuration (visit check-out channels are treated as exit). Channels marked as Check-in do not generate an entry/exit notification.

Check-in origin

Check-in from the app is recorded as a dedicated host notification type (AcceleroAPP), which allows ACCELERO to trigger the corresponding status notification to the application.


Use cases

Registering a resident from the application

  1. The resident installs the app and enters their data and the unit
  2. The app sends the record to ACCELERO, which creates the person, assigns the Default category for new residents, and links them to the unit with the configured Association of new residents
  3. The resident requests their access QR Code from the app
  4. At the front desk, the QR Code is presented at the access points normally

Visit invitation

  1. The resident creates an invitation in the app, entering the visitor, dates, and visit type
  2. ACCELERO generates the visit event with the Default event type and associates visitor and host
  3. The visitor receives an access QR Code valid for the visit period
  4. On each check-in, entry, and exit, ACCELERO updates the visit status in the app

Initial data load to the app

  1. In Settings > Integrations - AcceleroApp, Synchronization tab, select the desired Event types and Person categories
  2. Click on Synchronize data
  3. Track the completion notification of the background processing

Best practices

  • Dedicated default category: use a specific category for residents registered from the app, making it easier to apply access rules and reports.
  • Dedicated integration operator: configure a dedicated operator (e.g., "Accelero App Integration") as the party responsible for the plugin's operations, instead of a named account.
  • Assess data overwrite: keep Overwrite data of existing people disabled when the records have already been curated, to avoid unwanted changes coming from the app.
  • Distinct tokens: keep different tokens for each communication direction (APP → Accelero and Accelero → APP) and treat them as sensitive credentials.

Troubleshooting

People are not registered from the app

Possible causes:

  • The unit informed by the app does not correspond to any company (by code or description)
  • Default category for new residents or Association of new residents not configured
  • Incorrect Authentication token (APP > Accelero)

Solution:

  1. Confirm that the sent unit exists as a company in ACCELERO
  2. Check the General tab settings
  3. Confirm the token configured in the app and in ACCELERO

Bulk sending does not start

Possible causes:

  • No event type or person category selected in the Synchronization tab
  • A synchronization is already in progress

Solution:

  1. Select at least one event type and one person category
  2. Wait for the previous synchronization to complete before starting another

App does not receive visit status updates

Possible causes:

  • AcceleroApp URL or Authentication token (Accelero > APP) incorrect
  • Access channel configured as Check-in (does not generate entry/exit notification)
  • Visit or visitor link canceled

Solution:

  1. Check the URL and the notification token in the General tab
  2. Confirm the configuration of the channels used in the visitor's pass
  3. Check the status of the event and the visitor's link

Integration with other modules

People and Categories

The integration creates and updates People and uses the default Category configured for new residents.

Companies and Association types

The units correspond to Companies, and the resident's link uses a configured Association type.

Events (Visits)

Invitations generate visit Events with the configured default event type.

Logs and Monitoring

The visitor passes recorded in Logs and Monitoring trigger the status notifications to the app.


Next Steps

  • People — Understand the record created/updated by the app
  • Companies — Configure the synchronized units
  • Categories — Define the default category of new residents
  • Association types — Configure the link of new residents
  • Events — Understand the visits generated by invitations
  • Plugins — Learn more about ACCELERO's plugin system