AppToHome Integration
The AppToHome integration connects ACCELERO to the AppToHome platform, an application for managing residential complexes and developments. With the plugin active, AppToHome starts to command resident registrations, visit invitations, and QR Code generation directly in ACCELERO, while ACCELERO returns the access movements (entries and exits) to the application.
Communication is bidirectional: AppToHome calls the ACCELERO API to create and maintain data, and ACCELERO notifies AppToHome when a physical pass occurs in the monitored areas.
This integration is provided as a plugin (apptohome) and must be installed and enabled by IONGRADE's technical team. Contact support to check compatibility with your version of ACCELERO.
Current plugin version: 1.0.0 — compatible with ACCELERO 2.17.0 or higher.
What the integration does
AppToHome acts as the source system of the records: it sends resident and invitation data to ACCELERO via API, and ACCELERO keeps people, unit links, and visit events synchronized. In the reverse direction, ACCELERO reports each relevant access back to AppToHome.
| Feature | What happens in ACCELERO |
|---|---|
| Resident registration | AppToHome creates or updates the person in ACCELERO and associates them with the corresponding unit (company) |
| Resident deactivation | AppToHome requests the deactivation of a person, who is disabled in the record |
| QR Code generation | ACCELERO generates the person's QR Code (static or dynamic) and returns it to AppToHome |
| Visit invitation | AppToHome creates a visit event linking visitor and visited resident, and ACCELERO issues a virtual card (QR Code) for the visitor |
| Invitation cancellation | AppToHome cancels the invitation; the event and the visitor's link are canceled in ACCELERO |
| Query of event types | AppToHome reads the list of event types configured in ACCELERO |
| Query of units | AppToHome reads the list of companies (units) registered in ACCELERO |
| Access notification | Each physical pass through a configured entry or exit area is reported to AppToHome |
Centralizes resident and invitation management in AppToHome, while physical access control, credential issuance (QR Code), and pass recording remain in ACCELERO.
Configuration
Navigation path: Settings > Integrations - AppToHome
The configuration screen has the General tab.
Screen Settings > Integrations - AppToHome, General tab, showing the Operator, Authentication token, AppToHome URL fields, the "Overwrite data of existing people" switch, "Association of new residents", and the "Entry areas" and "Exit areas" lists.
General tab
| Field | Description |
|---|---|
| Operator | ACCELERO operator on whose behalf the operations received via API are executed. The actions created by the integration (events, links) are recorded under this operator |
| Authentication token (Access Key) | Token used to authenticate the calls that AppToHome makes to the ACCELERO API. It must be sent by AppToHome in the Authorization header of each request |
| AppToHome URL | Endpoint of the AppToHome service to which ACCELERO sends the access notifications |
| Overwrite data of existing people | When enabled, the data (name, document, email, phone, and photo) of an already registered person is updated on each record received from AppToHome. When disabled, only new people have their data filled in |
| Association of new residents | Association type (person-company link) applied when linking a new resident to their unit |
| Entry areas | Multi-selection of areas — passes with a destination in one of these areas are reported to AppToHome as entry |
| Exit areas | Multi-selection of areas — passes with a destination in one of these areas are reported to AppToHome as exit |
The Authentication token (Access Key) protects the API exposed by the plugin. Calls without the correct token in the Authorization header are rejected with an unauthorized error. Share the token only with the AppToHome service.
Only passes whose destination is an area marked in Entry areas or Exit areas generate a notification to AppToHome. Passes in other areas are ignored by the integration.
API exposed to AppToHome
The plugin provides a set of REST endpoints that the AppToHome application consumes. All calls require the Authentication token in the Authorization header; without it, the request is denied.
| Method and route | Function |
|---|---|
GET external/apptohome/tiposeventos | Lists the ACCELERO event types (code and description) |
GET external/apptohome/unidades | Lists the ACCELERO units/companies (code and description) |
POST external/apptohome/pessoas | Registers or updates a resident and associates them with a unit |
DELETE external/apptohome/pessoas | Disables a resident by document |
POST external/apptohome/qrcode | Generates a person's QR Code (static or dynamic) |
POST external/apptohome/invite | Creates a visit invitation (event with visitor and visited) |
DELETE external/apptohome/invite | Cancels a visit invitation |
These endpoints are consumed by the AppToHome service, not by operators in the ACCELERO interface. The payload details are defined in the integration contract between AppToHome and IONGRADE.
Resident registration
AppToHome sends name, document, email, phone, unit, and photo. ACCELERO:
- Locates the person by document. If it does not exist (or if Overwrite data of existing people is active), it records name, document, email, phone, and the photo.
- Associates the person with the informed unit (company), using the association type defined in Association of new residents. The link is created as pre-authorized and authorizing.
The sent unit must correspond to a company already registered in ACCELERO (company code field). If the unit is not found, the registration is refused.
Resident deactivation
AppToHome sends the person's document. ACCELERO locates the person and marks them as disabled. Unknown people generate a return error.
QR Code generation
From the person's document, ACCELERO generates the QR Code and returns it to AppToHome. The QR Code can be:
- Static — the person's fixed code (default behavior);
- Dynamic — a rotating code, when AppToHome requests the dynamic mode.
Visit invitation
AppToHome sends the event data (identifier, start and end dates, type), the visitor data (name, document, email, phone, photo), and the visited data (document and unit). ACCELERO:
- Validates that the unit exists, that the visited exists and is associated with the unit, and that the event type exists;
- Creates the visit event with the informed dates;
- Creates or updates the visitor record;
- Links visitor and visited to the event and generates a virtual card (QR Code) identified as
AppToHome <id>, valid during the visit period.
Sequence diagram of the visit invitation: AppToHome → ACCELERO API (create event, upsert of the visitor, event-person link, QR card issuance) → return of the link identifier.
Invitation cancellation
AppToHome sends the invitation identifier. ACCELERO locates the corresponding link, marks the event as canceled and the visitor's link as canceled — invalidating the issued virtual card.
Access notification to AppToHome
Whenever an effectively performed pass (real access) occurs whose destination is a configured area, ACCELERO sends AppToHome a notification containing the invitation identifier, the type (entry or exit), and the access time.
- Entry — the destination is one of the Entry areas;
- Exit — the destination is one of the Exit areas;
- Passes in other areas are not notified.
If the notification to AppToHome fails (service unavailable or a response other than success), ACCELERO re-enqueues the sending and tries again after an interval, avoiding loss of events.
Example of an access event of an AppToHome visitor in the Logs and Monitoring, evidencing the pass that triggers the notification.
Use cases
Enabling the integration for a development
- Request IONGRADE to install the
apptohomeplugin. - In
Settings > Integrations - AppToHome, set the integration Operator. - Enter the Authentication token agreed with AppToHome and the AppToHome URL.
- Choose the Association of new residents type and define the Entry areas and Exit areas.
- Save and validate with AppToHome the registration of a test resident and QR Code generation.
Receiving a new resident from AppToHome
- The resident is registered in AppToHome and linked to a unit.
- AppToHome sends the record to ACCELERO, which creates the person and associates them with the corresponding company.
- AppToHome requests the person's QR Code for use as an access credential.
Registering a visit invitation
- The resident creates the visit invitation in AppToHome.
- AppToHome sends the invitation to ACCELERO, which creates the visit event and issues the visitor's virtual card (QR Code).
- The visitor uses the QR Code at access; the pass is recorded and notified back to AppToHome.
Best practices
- Dedicated operator: create a specific operator (e.g., "AppToHome Integration") as the party responsible for the API operations, instead of using a named account.
- Strong token: use a long and unique authentication token for the integration and keep it confidential.
- Well-defined areas: map the Entry areas and Exit areas correctly so that the access notifications reflect the real movement.
- Decision on overwrite: enable Overwrite data of existing people only when AppToHome is the authoritative source of the registration data; otherwise, keep it disabled to preserve edits made in ACCELERO.
Troubleshooting
AppToHome calls return "Unauthorized"
Possible causes:
- Authentication token missing or incorrect in the
Authorizationheader. - Token configured in ACCELERO different from the one used by AppToHome.
Solution:
- Confirm the Authentication token (Access Key) in
Settings > Integrations - AppToHome. - Make sure AppToHome sends exactly this token in the
Authorizationheader.
Resident registration or invitation refused with "Unknown unit"
Possible causes:
- The sent unit does not correspond to any company registered in ACCELERO.
Solution:
- Check the company code in Companies.
- Align with AppToHome which unit code should be sent.
Accesses do not reach AppToHome
Possible causes:
- The pass destination area is not in Entry areas nor in Exit areas.
- The AppToHome URL is incorrect or the service is unavailable.
Solution:
- Review the Entry areas and Exit areas in the configuration.
- Confirm the AppToHome URL and the connectivity from the ACCELERO server to the service.
Integration with other modules
People
Residents and visitors received from AppToHome are recorded as People, identified by document.
Companies
AppToHome units correspond to Companies in ACCELERO; the person-unit link uses the Association Type defined in the configuration.
Events
Visit invitations create visit Events in ACCELERO, with visitor and visited linked.
Areas and Logs
The entry and exit Areas determine which passes are notified; see Logs and Monitoring to track the recorded accesses.