NovoMétodo Integration

The NovoMétodo integration connects ACCELERO to the NovoMétodo enrollment system. NovoMétodo sends enrollment events to ACCELERO, which automatically creates the classes (person categories) and the links between students, guardians, and the corresponding company. It is aimed at educational institutions that use ACCELERO for access control and want to keep people and classes in sync with the academic system.

Availability

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

Compatibility

Current plugin version: 0.1.0 — compatible with ACCELERO 2.16.0, 2.16.1, 2.16.2, and 2.16.3.

Depends on the Education integration

NovoMétodo locates students by the education.id identifier and companies by empCodigo, both filled in by the synchronization of the Education plugin. For NovoMétodo to work, the Education plugin must be installed and the records already synchronized.

---

What the integration does

The integration has no operational screens of its own: it exposes an API that NovoMétodo calls to create or remove enrollments. Each call triggers the creation/update of records in ACCELERO.

Feature	What happens in ACCELERO
Enrollment creation/update	Upon receiving an enrollment, ACCELERO locates the student, creates the class (if it does not yet exist), links the student to the class, and creates the person–company link with the given relationship type
Automatic class creation	If no person category with the class code (idClass) exists, it is created with the class description (className) and already enabled
Student–company link by type	The relationship type sent (className) is converted into an ACCELERO link type (Guardian, Sibling, Student, Others)
Enrollment removal	Upon receiving a removal, ACCELERO undoes the student's link with the class and the corresponding person–company link

Main benefit

Keeps classes and links of students and guardians synchronized automatically from NovoMétodo, with no manual registration of categories and relationships in ACCELERO.

Source of person and company records

The integration does not create people or companies. The student must already exist in ACCELERO (with education.id filled in) and have a company with empCodigo equal to their identifier in Education. If the student or the company is not found, the call returns an error.

---

Configuration

Navigation path: Settings > Integrations - NovoMetodo

The screen has a single tab: General.

TODO: Add Screenshot

The Settings > Integrations - NovoMetodo configuration screen, General tab, showing the Accelero Token field.

General tab

Field	Description
Accelero Token	Authentication token that NovoMétodo must send in the API calls (Authorization: Bearer <token> header). Set the same value configured on the NovoMétodo side

Screen buttons

Button	Function
Back	Returns without saving
Save	Persists the configuration

Required token

Without the Accelero Token filled in, all API calls are rejected. The token sent by NovoMétodo must be identical to the one configured here.

---

Enrollment API

The integration provides two endpoints, both protected by token authentication. They are called by NovoMétodo — there is no screen in ACCELERO to trigger them manually.

Method	Endpoint	Action
PUT	/external/novometodo/matricula	Creates or updates the enrollment (upsert)
DELETE	/external/novometodo/matricula	Removes the enrollment

Authentication

The calls require the Authorization: Bearer <token> header, where <token> is the value of the Accelero Token field. Requests without a token, with an invalid token, or with the integration misconfigured are refused.

Enrollment data (payload)

Field	Used in	Description
idPerson	PUT and DELETE	Student identifier in NovoMétodo/Education — used to locate the person by education.id
idClass	PUT and DELETE	Class code — becomes the code of the person category (class) in ACCELERO
className	PUT	Class description/type — used as the class description and to define the link type

TODO: Add Diagram

Diagram of the flow of an enrollment call: NovoMétodo → PUT /external/novometodo/matricula → locating the student → creating/using the class → student–class link → person–company link.

---

Link type mapping

When creating the enrollment, the value of className is converted into an ACCELERO person–company link type:

Received value (className)	Link type in ACCELERO
MOTHER, FATHER, GRANDFATHER, GRANDMOTHER, RESPONSIBLE, ADOPTER	Guardian
SISTER, BROTHER	Sibling
ALUNO	Student
OTHER	Others
Any other value	The received text itself is used as the description of the link type

If the corresponding link type does not yet exist in ACCELERO, it is created automatically.

---

How the flow works

Enrollment creation/update (PUT)

1. ACCELERO locates the student by the person whose education.id equals idPerson. If not found, it returns the error Student not found.
2. It looks for the class (person category) by the code idClass. If it does not exist, it creates the class with the description className, already enabled.
3. It links the student to the class (if not already linked) and enables the person.
4. It locates the company by empCodigo equal to idPerson. If not found, it returns the error Company not found.
5. It determines the link type from className (see mapping above) and creates the person–company link (if it does not yet exist).

Enrollment removal (DELETE)

1. Locates the student by education.id. If not found, it returns the error Student not found.
2. Locates the class by the code idClass. If it does not exist, it returns the error Class not found.
3. Removes the student's link with the class.
4. Removes the person–company link corresponding to the type derived from className.

Errors return to the API

When something prevents the operation (student, company, or class not found, invalid data, failure to save/remove), the call returns an error with the corresponding message. NovoMétodo is responsible for handling and reprocessing these errors.

---

Use cases

Enable the integration for an institution

1. Request that IONGRADE install the novometodo plugin.
2. Make sure the Education plugin is installed and that people and companies have already been synchronized.
3. In Settings > Integrations - NovoMetodo, fill in the Accelero Token.
4. Provide the same token and the API URL to the person responsible for the configuration in NovoMétodo.
5. Perform a test enrollment and check, in ACCELERO, the creation of the class and the links.

Enrollment of a student with a guardian

1. NovoMétodo sends an enrollment with className = ALUNO for the student.
2. NovoMétodo sends another enrollment with className = MOTHER (or another guardian) for the same idClass.
3. In ACCELERO, the class is created once; the student gets the Student link and the guardian the Guardian link, both tied to the student's company.

---

Best practices

• Synchronize Education first: people without education.id and companies without empCodigo are not located — confirm the Education synchronization before triggering enrollments.
• Strong token, identical on both sides: use a long token and keep exactly the same value in ACCELERO and in NovoMétodo.
• Use a test value before production: validate a test enrollment and check the class and links created before releasing the full flow.

---

Troubleshooting

The calls return a token error

Possible causes:

• The Accelero Token field is empty in the configuration.
• The token sent by NovoMétodo differs from the one configured in ACCELERO.
• The Authorization header is missing from the request.

Solution:

1. Confirm the value in Settings > Integrations - NovoMetodo.
2. Make sure NovoMétodo sends Authorization: Bearer <token> with the same value.

"Student not found" error

Possible causes:

• The person corresponding to idPerson does not exist in ACCELERO.
• The person exists, but without the education.id filled in.

Solution:

1. Check whether the student was synchronized by the Education plugin.
2. Reinforce the Education synchronization and resend the enrollment.

"Company not found" error

Possible causes:

• No company with empCodigo equal to the student's idPerson exists.

Solution:

1. Confirm that the Education synchronization created the student's company with the correct empCodigo.

"Class not found" error (on removal)

Possible causes:

• The class (idClass) was never created — there was no prior enrollment, or the category was removed manually.

Solution:

1. Confirm that the corresponding enrollment exists before sending the removal.

---

Integration with other modules

People

The integration locates students in the People registry by the Education identifier and enables them when linking them to a class.

Companies

The links are created against Companies located by the empCodigo corresponding to the student.

Categories (classes)

Each NovoMétodo class is represented by a person category in ACCELERO, created automatically when needed.

Education

The integration depends on the Education plugin synchronization so that people and companies exist and are correctly identified.

---

Next Steps

• Education — Understand the synchronization that feeds the people and companies used by this integration
• People — See how students are registered and enabled
• Companies — Understand the person–company links created by the integration
• Plugins — Learn more about the ACCELERO plugin system