API: joint debug and go-live checklist
Pre-launch checks for API integration.
integrationapi
Audience: IT / integrators · Applies to: SaaS / private deployment
Environment and credentials
- Base URL points at the correct environment (not production by mistake)
- Credential permissions match the target org
- Secrets live only on the server—not in frontend or a public repo
Sync behavior
- Idempotency keys and retry policy verified (duplicate submit does not dirty data)
- Error logs can trace back to an external business ID
- Rate limits and timeouts configured or load-tested as agreed
Business smoke
- Can sync or create classes
- Can sync teachers/students and build class membership
- (Optional) Can create tasks or pull practice results
- Spot-check login and practice with real teacher/student accounts in the App
Rollback and on-call
- After stopping sync, CSV can still remediate
- Contacts and on-call path shared with support
For private deploy also see Private deploy.