Quickstart

Get Started

Start integrating with OptiSigns API by following these simple steps:

1. Access the GraphQL IDE

Using the GraphQL IDE

2. Authentication

Setting up Authentication

Core API Operations

Query Operations

List All Devices

Fetch all devices in your account:

query{
  devices (query : {}) {
    page{
      edges{
        cursor,
        node{
          _id,
          deviceName,
          UUID,
          pairingCode,
          currentType,
          currentAssetId,
          currentPlaylistId,
          localAppVersion,
        }
      }
    }
  }
}

Example Response:

{
  "data": {
    "devices": {
      "page": {
        "edges": [
          {
            "cursor": "YXJyYXljb2luZW50aW9uOjA=",
            "node": {
              "_id": "G158712f0e404274e7300e7f",
              "deviceName": "TOMATO",
              "UUID": "c1af1246-d1c8-3e7c-a04b-9914579f5342",
              "pairingCode": "5MMESU",
              "currentType": "asset",
              "currentAssetId": "TQ7d4Nc4kZhjwF29F",
              "currentPlaylistId": null,
              "localAppVersion": "5.5.8"
            }
          }
        ]
      }
    }
  }
}

Fetch Specific Assets

Retrieve asset details by filename:

query{
  assets (query : {originalFileName:"Sample Image 1.JPG"}) {
    page{
      edges{
        cursor,
        node{
          _id,
          appType,
          fileType,
          name,
          filename
        }
      }
    }
  }
}

Example Response:

{
  "data": {
    "assets": {
      "page": {
        "edges": [
          {
            "cursor": "YXJyYXljb2luZW50aW9uOjA=",
            "node": {
              "_id": "fAzD64mkENvCtde3p",
              "appType": null,
              "fileType": "image",
              "name": null,
              "filename": "Sample Image 1.JPG"
            }
          }
        ]
      }
    }
  }
}

Next Steps

API Reference

Explore the complete API schema and operations

Device Management

Learn about device control and monitoring

Content Management

Manage digital signage content and playlists

Best Practices

Tips for optimal API integration

Get Started

Optisigns GraphQL API

Optisigns SDK

Get Started

1. Access the GraphQL IDE

2. Authentication

Core API Operations

Query Operations

Next Steps

API Reference

Device Management

Content Management

Best Practices

Get Started

Optisigns GraphQL API

Optisigns SDK

​Get Started

​1. Access the GraphQL IDE

​2. Authentication

​Core API Operations

​Query Operations

​Next Steps

API Reference

Device Management

Content Management

Best Practices

Get Started

1. Access the GraphQL IDE

2. Authentication

Core API Operations

Query Operations

Next Steps