As of 1-June-2019 all published endpoints will be renamed in closer conformance to industry standards.
VitalSource has elected to remove most descriptors previously attached as a layer on top of our API endpoints.
Base Naming Pattern
Wherever possible endpoints will be displayed in Create, Read, Update, Destroy (CRUD) order. Exceptions will be where this violates basic VitalSource workflows.
The URL will be shown to include parameters such as :vbid, :code, :pkg_sku or :param when multiple options exist.
|
TYPE
|
URL
|
Title
|
Descriptor
|
Example
|
|---|---|---|---|---|
| POST | ending URL | Create | if needed | v3/codes - Create |
| GET | ending URL | Read | if needed | v4/packages/:pkg_sku - Read |
| PUT | ending URL | Update | if needed | /vital_books/:vbid - Update |
| DELETE | ending URL | Delete | if needed | v4/codes/:code - Delete/Cancel/Refund |
Revision Schema
|
Type
|
Old
|
New
|
|---|---|---|
| POST | VitalBook Create | /vital_books - Create VitalSource Book (VBID) |
| GET | VitalBook Update | /vital_books/:vbid - Read |
| PUT | VitalBook Update | /vital_books/:vbid - Update |
| POST | Create Package | v4/packages - Create |
| GET | Update Package | v4/packages/:pkg_sku - Read |
| UPDATE | N/A | v4/packages/:pkg_sku - Update |
| DELETE | Remove Asset from a Package | v4/packages/:pkg_sku/assets - Delete |
| POST | Send Recommendation | v3/publisher/recommendations - Create |
| GET | Engagement API | v3/publisher/engagement - Read |
Comments
Please sign in to leave a comment.