Note:
This API requires the Bob Learning module. If your company does not have Learning enabled, you will not be able to use the Learning provider integrations endpoints. To learn more, see Bob Learning.
The Bob Learning API lets an external learning provider (or an integration developers in‑house) connect a course catalog to Bob Learning.
Required permissions
Before using the Learning API, make sure your integration has the required access, just as you would when assigning permissions to a user in Bob.
To do this, you should choose one of the following authentication methods and assign the relevant permissions/scopes:
| Authentication method | Description | Permissions |
|---|---|---|
| Service user (Basic Auth) | Recommended for customer-built/internal integrations. The calling service user must have permissions to manage Learning provider content | Features > Integrations > Course providers > Create, update and delete the integration |
| OAuth (Bearer token) | Used for marketplace/partner apps. The calling app must have scopes that allow to manage Learning provider content | Integrations > Manage learning integrations learning.integrations:write |
If the calling integration does not have the required permissions, the API will return an authorization error (for example, 403 Forbidden).
Rate limits
The Bob Learning Public API provides endpoints for managing integrations, courses, and repoting progress.
| Public API endpoints | Rate limit (per minute) |
|---|---|
| Create integration | 3 |
| Delete integration (soft delete) | 3 |
| Create training content (bulk insert) | 10 |
| Update training content (bulk patch) | 10 |
| Archive training content (bulk) | 10 |
| Submit xAPI statement | 300 |
