Dovient API Reference
Comprehensive documentation for integrating with Dovient's maintenance platform API.
Base URL
https://api.dovient.com/v1
Authentication
All API requests require an API key passed in the Authorization header.
Rate Limits
Standard tier: 100 requests/minute
Enterprise tier: 1000 requests/minute
Getting Started
Introduction
Welcome to the Dovient API documentation. This comprehensive guide will help you integrate with our maintenance platform API.
Getting Started
The Dovient API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
The Dovient API uses API keys to authenticate requests. You can view and manage your API keys in the Dovient Dashboard.
API Key Authentication
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authorization: Bearer YOUR_API_KEY
Rate Limits
The Dovient API implements rate limiting to ensure fair usage and maintain service quality for all users.
Rate Limit Tiers
- Standard tier: 100 requests per minute
- Enterprise tier: 1000 requests per minute
Errors
Dovient uses conventional HTTP response codes to indicate the success or failure of an API request.
HTTP Status Codes
Code | Description |
---|---|
200 | OK - Everything worked as expected |
400 | Bad Request - The request was unacceptable |
401 | Unauthorized - No valid API key provided |
404 | Not Found - The requested resource doesn't exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error - Something went wrong on our end |
Pagination
All list endpoints support pagination using limit and offset parameters.
Pagination Parameters
limit
: Number of items to return (default: 20, max: 100)offset
: Number of items to skip (default: 0)
Versioning
The Dovient API is versioned to ensure backward compatibility as we add new features.
Current Version
The current API version is v1. All requests should be made to:
https://api.dovient.com/v1
Assets API
The Assets API allows you to manage equipment and assets in your Dovient account. You can create, retrieve, update, and delete assets, as well as manage their maintenance history and schedules.
Returns a list of assets in your account. The assets are returned sorted by creation date, with the most recently created assets appearing first.
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
limit | integer | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
offset | integer | No | The starting index for the results. Default is 0. |
status | string | No | Filter assets by status (active, inactive, maintenance). |
Example Request
curl -X GET "https://api.dovient.com/v1/assets?limit=10&status=active" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Example Response
{
"data": [
{
"id": "ast_123456789",
"name": "Pump Station #42",
"description": "Main water pump for Building A",
"status": "active",
"category": "pump",
"location": {
"facility_id": "fac_987654321",
"building": "Building A",
"floor": "1",
"room": "Mechanical Room"
},
"manufacturer": "PumpCo Industries",
"model": "PC-5000",
"serial_number": "SN12345678",
"purchase_date": "2021-03-15",
"warranty_expiration": "2024-03-15",
"last_maintenance": "2023-01-10",
"next_maintenance": "2023-04-10",
"created_at": "2021-03-20T14:30:00Z",
"updated_at": "2023-01-12T09:45:00Z"
}
],
"meta": {
"total": 42,
"limit": 10,
"offset": 0
}
}