Contents
This section provides a brief overview of the API reference pages to aid in finding targeted information for your use case(s). The table of contents below are designed to help you quickly locate the information you need. They include links to all the topics covered in the API reference pages, along with a brief description of their contents.
To help you get started, each API has an OpenAPI specification page, containing full details in the standard OpenAPI format. In addition to these pages, we've also included guidance and usage examples to help you easily get up and running. These resources are designed to help you quickly understand how to use our APIs and integrate them with your existing business systems.
Intake APIs
| Link | Description |
|---|---|
| OpenAPI Specification | The full OpenAPI Specification for the intake APIs. |
| Using the Jobs endpoints | General information about usage of the jobs endpoints, which are common across the intake APIs. |
| Sourcing Event creation | Examples of Sourcing Event creation, illustrating the most common concepts of this API. |
| Sourcing Event from Template creation | Examples of Sourcing Event creation using an existing sourcing event as a template, illustrating the most common concepts of this API. |
| Sourcing Event update | Examples of updating existing Sourcing Events, illustrating the most common concepts of this API. |
| Sourcing Request creation | Sourcing Request creation examples, showing how reqeusts for Autonomous Sourcing bots are created. |
| Additional Information | Additional notes about the intake APIs. |
Export APIs
| Link | Description |
|---|---|
| OpenAPI Specification | The full OpenAPI Specification for the export APIs. |
| Using the Feeds endpoints | General information about usage of the Feeds endpoints, which are common across the export APIs. |
| Award Feed | Examples outlining common usage scenarios of the Award feed export API. |
| Latest Bids Feed | Examples outlining common usage scenarios of the Latest Bids feed export API. |
| Sourcing Events Feed | Examples outlining common usage scenarios of the Sourcing Events feed export API. |
Supplier Management APIs
| Link | Description |
|---|---|
| OpenAPI Specification | The full OpenAPI Specification for the supplier management API. |
| Using the Supplier Management API | General information about usage of the supplier management endpoints. |
Webhook API
| Link | Description |
|---|---|
| OpenAPI Specification | The full OpenAPI Specification for the webhook API. |
| Using the Webhook API | General information about configuring webhooks and consuming the resulting push notifications. |
| List of subscribable events | List of events configured webhooks can subscribe to and the notification content for those events. |