Skip to main content
The OptiSigns TypeScript SDK provides a simple and intuitive way to manage your digital signage infrastructure programmatically. This documentation covers the main features and examples for common use cases.

Installation

Authentication

Initialize the SDK with your API key. Obtain your key from the account settings.

Core Operations

Devices

List All Devices

Find Device by Name

Get Device by ID

Create New Device

Update Device

Delete Device

Content Management

Upload File Asset

Create Website Asset

Modify Asset Settings

Common Use Cases

Managing Digital Screens

  1. Push Content to Screen:
  1. Reboot Device:

Error Handling

The SDK uses TypeScript for better type safety and includes comprehensive error handling. Always wrap API calls in try-catch blocks:

Best Practices

  1. Error Handling: Always implement proper error handling in your applications
  2. Authentication: Keep your API key secure and never expose it in client-side code
  3. TypeScript: Take advantage of TypeScript types for better code completion and error detection
  4. Team ID: Keep track of your team ID for operations that require it

Code Examples

For more detailed information, visit our API Reference or contact our support team at support@optisigns.com.