various API example calls for use in testing and developing against the CV3 APIs
There are a variety of client-side technologies and toolkits that can be used to access the CV3 REST API and exchange data. Here we collect examples so that integration developers can review working code to get started with their own integrations.
In most cases we suggest developers utilize the included Postman Collections. It can be very useful throughout a project to have a quick way to test the request/response details without the complications of any project-specific code. In addition, when working with other developers or CV3 Support it can be used to share code, problems and solutions among folks that may not have access to the specific tools and technologies you're using in your project.
All examples require a "REST_KEY" and a "REST_SECRET". These are provided by CV3. Instructions for setting up the API for use are here. Please note:
- API access credentials and use is limited to a sub-user and you should set permissions correctly for that sub-user
- Review the expiration information on credentials carefully.
Postman is a popular application used to test and explore various APIs. Many of these examples are offered as "Postman Collections" that can be easily imported and configured for use. All of these collections work with the free & paid versions of Postman.
- If you aren't using it already, download and install Postman.
- If you don't have a Workspace you want to use, create a Postman Workspace
- In the Workspace view, click
Importin the Collections sidebar - Click
Uploadand choose one of our example collections (*.postman_collection.json files) - Configure any necessary Global Postman variables for use with the collection
This last step is explained in more detail in each collection's README.md file. In general it will involve making sure you have Global Variables set in Postman for the API authentication information.
Contribute here or just send your examples to CV3 support and we'll add them.