Automate Your Technical Documentation with the StageDB API
Streamline your workflow and integrate your existing applications directly with StageDB. Our new REST API allows you to programmatically create projects and generate comprehensive technical documentation for your equipment lists, delivering them directly to any email address.
This powerful feature is designed to save you time by automating the entire documentation process, from equipment selection to final delivery.
How It Works
The process is simple and designed for seamless integration. Your external application sends a POST request to our API endpoint. This single request can:
The entire workflow is configurable from your application, giving you full control over the output without ever needing to log into the StageDB interface.
Key Features
Getting Started
Request Your API Key
To begin using the API, you will need to request an API key from our support team. This key is unique to your company and will be used to authenticate your requests.
Authentication
All API requests must be authenticated using your secret API key as a Bearer token in the Authorisation header.
Authorisation: Bearer YOUR_SECRET_API_KEY).
Pricing
We offer a simple, transparent pricing model. The API key comes with a one-time setup fee. This fee is only charged after you have successfully implemented and tested the integration, ensuring you only pay when the solution is working for you.
API Endpoint & Example
You can create a new project and trigger the documentation build by sending a POST request to the following endpoint: https://stagedb.com/api/v1/projects
Example Request
Below is a cURL example demonstrating how to create a project, specify equipment, and configure the output document and email. Most fields are optional, so you can tailor the payload to your specific needs.
JSON
curl -i -X POST https://stagedb.com/api/v1/projects
-H “Authorization: Bearer STGDB_secret_api_key_aaa1aaA1aAaA1AaA1AAaaaaaA11AaA1aAAaAAaAAaAa”
-H “Content-Type: application/json”
-d ‘{
“project”: {
“name”: “New Project”,
“starts_on”: “2025-03-01”,
“finishes_on”: “2025-03-31”,
“equipment”: {
“default_html_note”: “This is a test
project
“,
“serial_numbers”: [“03010-011”, “03010-012”],
“asset_codes”: [“RUN-01/30-089UD-B-305-036”, “AC002”]
},
“bundle”: {
“template_id”: 1,
“signer_user_email_address”: “test@test.com”,
“options”: [“test”, “test2”]
},
“email”: {
“subject”: “Project Update: Technical Documentation Ready”,
“html_body”: “<h1>The technical file has been created successfully.</h1><p>You can download it using the link provided.</p>”,
“email_addresses”: [“client@example.com”, “manager@example.com”]
}
}
}’
“email_addresses”: [“client@example.com”, “manager@example.com”]
}
}
}’