This repository contains examples and sample code demonstrating how to use the QbDVision REST API. Each example is self-contained and illustrates a specific API feature or use case.
To use these examples, you'll need:
- A QbDVision account with your organization (or a sandbox account)
- An API Key from the API Keys page:
- Static API Key
- OAuth 2.0 Credentials: Generate your own Client ID and Client Secret through the QbDVision UI
- See our OAuth 2.0 Authentication Guide for detailed setup instructions
- The interpreter for the example you're working with (either in Python 3.13+ or Node.js 20.18+)
Each directory in this repository focuses on a specific aspect of the API:
/batch_record_api_import- How to import batch records using the API (Node.js)/coa_api_import- How to import a Certificate of Analysis (CoA) documents/records using the API (from a PDF from the manufacturer) (Node.js)/coa_api_import_json- How to import a Certificate of Analysis (CoA) documents/records using the API (from a JSON file with the values) (Node.js)/import_data_from_json- Importing basic record data from a JSON file (Python)/import_records_from_xlsx- Importing basic record data from an Excel file (Node.js)/process_explorer/get-all-records- How to use the Process Explorer API to download multiple records (Node.js)/process_explorer/oauth-get-all-records- How to use OAuth keys to authenticate and then use the Process Explorer API to download multiple records (Node.js)/process_explorer/oauth-get-all-records_py- How to use OAuth keys to authenticate and then use the Process Explorer API to download multiple records (Python)/process_explorer/process-graph- Use the Process Explorer API to download all records and then displays them as a graph (Node.js)
Each example includes:
- Source code with detailed comments
- A README explaining the specific use case
- Requirements and setup instructions
To run an example:
# Clone this repository
git clone https://github.com/QbDVision-Inc/qbdvision-api-examples
# Navigate to an example directory
cd qbdvision-api-examples/process_explorer
# Follow the example-specific README-
Authentication
- OAuth 2.0 Authentication Guide - Comprehensive guide for setting up and using OAuth 2.0 credentials
-
REST API Reference
- This differs by environment, since different environments are different releases (with different features).
-
API Objects Reference - This page provides the list of objects and their attributes that can be used with the API.
We welcome contributions! Please email support@qbdvision.com to get in touch.
This repository is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or need help, you can:
These examples are for demonstration purposes only. In production, you should always follow security best practices and error handling guidelines.