Version: 1.6.1

Node.js: 20.x+

Python: 3.6+

Locktera API Documentation

Locktera API Documentation

Welcome to the Locktera API documentation! This guide provides all the necessary details to work with the Locktera API, including authentication methods, endpoints, usage limits, and examples to help developers interact with the Locktera platform efficiently. The Locktera API is designed to be secure, reliable, and scalable, giving developers access to manage and configure organizational data, containers, DRM (Digital Rights Management), API keys, and resource usage effectively.

Overview

The Locktera API enables administrators and developers to:

• Manage Organizations: Configure organization details, manage access and audit logs, track consumption, and customize settings.
• Control User Access: Set API keys, address book entries, and handle user consent management.
• Configure Storage: Set up storage configurations across multiple services like Azure, S3, and custom storage options.
• Monitor DRM Rules: Manage and enforce Digital Rights Management (DRM) rules, ensuring secure content access.
• Audit Activity: Log and review events, access logs, and audit trails to keep track of actions within the organization.
• Service Status Monitoring: Check the health of various Locktera services in real-time to maintain availability and reliability.

---

Explore Documentation

Explore the features and functionalities of the Locktera platform through these comprehensive guides:

Address Book Management

Manage address book entries, including email addresses, names, and companies.

API Key Management

Generate and manage API keys for authentication.

Consent Management

Manage user and viewer consents for compliance and tracking.

Container Management

Organize and manage containers for storing data.

Customization Management

Customize platform settings and configurations for your organization.

DRM Storage Configuration

Configure and manage digital rights management (DRM) settings for storage.

Error Management

Log and retrieve error events and monitor service status.

Events Management

Track and manage events for containers and organizations.

Organization Management

Manage organizations, configure settings, and access audit logs.

Tag Management

Set up and manage tags for categorizing and organizing data.

Use Case: Write DRM Rules

Modify DRM rules on an existing container.

Use Case: Encode a folder

Encode a new Locktera container.

---

Authentication

To access the Locktera API, you will need a valid API key associated with your organization. This key should be included in the header of each request.

Example of the Authentication Header:

Authorization: Bearer YOUR_API_KEY

Getting an API Key

API keys can be created and managed through the API Key Management section. You must have administrative permissions within your organization to generate new API keys.

---

Base URL

All Locktera API requests are made to the following base URL:

https://api.locktera.com/v1

Ensure that all requests follow this format, appending the specific endpoint path as documented.

---

Rate Limiting

To maintain optimal service levels, the Locktera API enforces rate limits on requests. By default:

• Standard Users: 100 requests per minute
• Admin Users: 500 requests per minute

Exceeding these limits will result in a 429 Too Many Requests response. Consider implementing exponential backoff or retry strategies to handle these situations gracefully.

---

Response Format

The Locktera API uses JSON for all responses. Successful responses return an HTTP status code of 200 OK, while errors are indicated by standard HTTP status codes, such as:

• 400 Bad Request: Invalid request data
• 401 Unauthorized: Missing or invalid API key
• 403 Forbidden: Insufficient permissions
• 404 Not Found: Resource not found
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server error

Each error response contains a JSON body with an error message and code for easier debugging.

---

Usage Guidelines

Best Practices

1. Authenticate Requests: Always include a valid API key in the header of your requests.
2. Optimize API Calls: Use pagination, filtering, and sorting options as documented to avoid excessive data retrieval.
3. Handle Errors Gracefully: Implement error-handling logic to manage potential errors, especially for rate-limiting responses.
4. Monitor Rate Limits: Ensure your application respects rate limits to avoid disruptions.
5. Use Secure Connections: All requests should be made over HTTPS for security.

---

API Versioning

The Locktera API is versioned to ensure backward compatibility and manage updates effectively. All requests in this documentation are based on version v1. Version numbers are included in the URL (e.g., /v1/orgs), and Locktera will announce any breaking changes before releasing a new version.

Future Updates

• Deprecation Policy: Endpoints from older versions will be supported for at least 6 months after the release of a new version.
• Change Announcements: Check for announcements in your developer dashboard to stay updated on any new changes or deprecations.

---

Pagination and Filtering

For endpoints returning large data sets, the Locktera API supports pagination, sorting, and filtering.

Pagination Parameters

Parameter	Type	Description
page	int	Page number (1 by default)
limit	int	Number of results per page

Filtering by Timestamps

Use the optional start and end query parameters for date filtering. All timestamps should be in ISO UTC format:

?start=2023-01-01T00:00:00Z&end=2023-01-31T23:59:59Z