Developers · API documentation

Permissions

What each EduPay API key permission unlocks, and the ready-made bundles.

Each key has a list of permissions. Each route requires one permission, shown next to the address in the Reference. A key without the permission gets 403 with code insufficient_scope and the list of what is missing in scopes — before EduPay checks whether the record exists.

Rules

  • Read and write are separate. students:write does not include students:read: tick both if the integration does both.
  • Related data requires the permission of its own area. In GET /enrollments?include=student,installments, the student requires students:read and the installments require billing:read. This way, an enrollments-only key does not see the CPF (Brazilian individual taxpayer ID) or the address.
  • * unlocks everything, including whatever is added later. Use it only in the school's own, well-protected integration.
  • GET /me answers any key.

Ready-made bundles

The create key screen has bundles that tick the right permissions for you:

  • Read only (reports, BI, ERP): reads the catalog, students, enrollments and billing.
  • Read and write (ERP, CRM, store): everything in the read bundle, plus creating students, creating and cancelling enrollments, issuing second copies and the student portal link.
  • Moodle (full, SSO only, block only): the Moodle plugin permissions.

Webhooks through the API (webhooks:manage) are left out of the bundles: tick it when the system will register its own webhook endpoint.

All permissions

PermissionUnlocksReady-made bundles
moodle:auth Moodle single sign-on through EduPay (auth_edupay plugin). Moodle (full) · Moodle (SSO only)
moodle:student Student financial summary in the Moodle block (block_edupay plugin). Moodle (full) · Moodle (block only)
moodle:portal Student portal sign-in link from the Moodle block. Moodle (full) · Moodle (block only)
catalog:read Read offerings, tracks, cohorts, payment plans and sales pages. Read only (reports, BI, ERP) · Read and write (ERP, CRM, store)
students:read Read students, including tax ID and address. Read only (reports, BI, ERP) · Read and write (ERP, CRM, store)
students:write Create and update students. Read and write (ERP, CRM, store)
enrollments:read Read enrollments and contracts, including the PDF. Read only (reports, BI, ERP) · Read and write (ERP, CRM, store)
enrollments:write Create and cancel enrollments. Read and write (ERP, CRM, store)
billing:read Read installments, payment details and the student financial summary. Read only (reports, BI, ERP) · Read and write (ERP, CRM, store)
billing:write Issue a second copy of an installment. Read and write (ERP, CRM, store)
webhooks:manage Register and monitor webhook endpoints. —
* Every permission, including future ones. Use only in your own, well-protected integration. —