API: Applies to scenarios
When to use API integration, and the division of labor with CSV.
integrationapi
Audience: IT/Integrators · Applies: SaaS / private
Goal: Confirm whether the API is suitable for the current stage and read the integration guideation in order.
Suitable
- Regular synchronization with academic admin / SIS / Central Office** teachers, students and classes
- Need to programmatically create jobs and pull practice results
- Unified access by integrators after private deployment
Not suitable
- One-time small-scale file creation (priority CSV)
- No development resources, unable to store keys on the server
- Only need to export snapshots of your scores occasionally (export as CSV)
Division of labor with CSV
| Matters | CSV | API |
|---|---|---|
| First field validation | Recommended | Can be done later |
| Daily incremental synchronization | Not recommended | Recommended |
| Manual error correction | Recommended | Optional |
For a general selection list, see Which data intake method to use.
Reading order
- Preparation before integration
- Authentication and Calling Convention
- Typical synchronization process
- Joint debugging and online list
This help center describes the business sequence and check items; the specific paths and fields are subject to the API / OpenAPI documentation of the current environment.