Overview
Public documentation for the Cademí API v3, release 3.3.2. The base URL is https://api.cademi.com.br/api/v3, and every response includes the X-Cademi-Release header with the release that served it.
Start with Authentication, check what your credentials can do in Permissions and scope, and use Examples to make your first call.
Guides
| Guide | Topics |
|---|---|
| Authentication | Autonomous credentials, human mode with OAuth, headers, authentication failures |
| Permissions and scope | Permissions, policies, scope selectors, delegation |
| Pagination, filtering, and conditional requests | Collection envelope, cursors, filters, sorting, ETag, and conditional writes |
| Errors | Error envelope, error code catalog, how to handle each error class |
| Asynchronous operations, batches, and idempotency | Idempotency, asynchronous operations, items, resuming, cancellation, batches |
| Limits, quotas, and retention | Requests per minute, request size, retention |
| Files and uploads | Upload sessions, parts, file_id, download links |
| Webhooks | Signatures, envelope, delivery attempts, redelivery |
| Event catalog | Events available in each version, with visibility and payload keys |
| Event streams | SSE event streams and test scenarios |
| Sandbox | Sandbox account, what is real and what is simulated, how to trigger each error |
| Versioning and compatibility | Versioning axes, compatible changes, deprecation |
| Human mode (OAuth) | Administrator authorization, scopes, token renewal |
| Declarative configuration | Manifest, plan, and apply |
| Certificates and legal terms | Issuance, revocation, reissuance, legal terms |
| Diamond automations | Diamond funnel: stages, triggers, links |
| Imports, exports, and reports | Spreadsheets, exports, and reports |
| Changelog | Release notes for each version |
Reference
One page per operation group, generated from the release. The release contains 395 operations in 50 groups, organized in 12 areas.
| Area | Group | Operations |
|---|---|---|
| Access | Capabilities | 1 |
| Credentials | 15 | |
| Sandbox | 5 | |
| OpenAPI | 1 | |
| Students | Users | 38 |
| Enrollments | 5 | |
| Tags | 5 | |
| Custom fields | 5 | |
| Gamification | 2 | |
| Catalog and content | Products | 19 |
| Modules | 9 | |
| Lessons | 16 | |
| Taxonomies | 10 | |
| Showcases | 9 | |
| Exams and certificates | Exams | 19 |
| Questions | 10 | |
| Certificates | 8 | |
| Sales | Gateways | 2 |
| Deliveries | 12 | |
| Sales events | 5 | |
| Sales transactions | 2 | |
| Student area | Banners | 7 |
| Menus | 8 | |
| FAQs | 6 | |
| Legal terms | 7 | |
| Account | Account | 2 |
| Domains | 3 | |
| Replicas | 2 | |
| Administrators | 8 | |
| Settings | General settings | 14 |
| Access and sign-up | 8 | |
| Email settings | 7 | |
| Support settings | 8 | |
| Custom code | 5 | |
| Configuration | 3 | |
| Student support | Tickets | 9 |
| Departments | 5 | |
| Comments | 9 | |
| Automations and events | Webhooks | 13 |
| Events | 2 | |
| Event streams | 5 | |
| Diamonds | 18 | |
| Data and files | Imports | 10 |
| Exports | 4 | |
| Reports | 12 | |
| Files | 4 | |
| Uploads | 6 | |
| Async operations and audit | Operations | 8 |
| Requests | 2 | |
| Audit entries | 2 |
Examples
Examples provides ready-to-run .http files, one per topic, each with the request, headers, body, and expected response. Each example lists at the top the permissions your credentials need. The examples run against every release, so each one returns what it documents.