Skip to content

AmazonPrime API

Version: 1.0.0

Status: ⚫⚪⚪

AmazonPrime interface for Thunder framework.

(Defined with IAmazonPrime in IAmazonPrime.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the AmazonPrime interface (version 1.0.0). It includes detailed specification about its methods provided and notifications sent.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

AmazonPrime JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the AmazonPrime interface:

AmazonPrime interface methods:

Method Description
send Send a message over the message bus to ignition

send method

Send a message over the message bus to ignition.

Parameters

Name Type M/O Description
params string mandatory ...

Result

Name Type M/O Description
result null mandatory Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.send",
  "params": "..."
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the AmazonPrime interface:

AmazonPrime interface events:

Notification Description
receive Receive a message from the generic message bus

receive notification

Receive a message from the generic message bus.

Notification Parameters

Name Type M/O Description
params string mandatory ...

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.register",
  "params": {
    "event": "receive",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.receive",
  "params": "..."
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.receive.