Canopy’s API allows you to automatically pull data from, and push data to, any Supplier Profile on the platform.
The most common use cases for the API are:
- to integrate Canopy with downstream systems;
- to extract data for reporting and analytics;
- to update Canopy with activity in adjacent systems.
In this article you will learn:
Types of API
Canopy operates 3 APIs, as follows.
/suppliers
- Pulls all ‘flags’ and ‘statuses’ about the supplier
- Used to determine changes in their profile and the stage of workflow the supplier is in
Click here for more information about the /suppliers API.
/answers
- Pulls all fields in the data framework about the supplier, including the answer to questions
Click here for more information about the /answers API.
/file
- Downloads documents that have been uploaded to the Supplier Profile on Canopy
Click here for more information about the /file API.
Integrating Canopy with ERP
Canopy can act as the control centre for your ERP system.
By connecting Canopy’s API with your ERP system, you can:
- Automatically set up new supplier profiles in ERP, saving time and reducing errors
- Enable suppliers to update their bank details, without having to enter your ERP system
- Trigger 'PO-Hold' and 'Payment-Hold' flags in ERP via Canopy’s compliance and business rules
- Ingest spend data into Canopy, keeping risk rules current and classifying spend in the right way
For more information about connecting Canopy with your ERP system, please contact your Administrator.
Technical API documentation
You can find technical documentation about the API by following this link.
To access the API, you will need to be issued with an x-api-key. Please contact your Administrator if you require the key.