Cisco Cisco Prime Home 2.4 Guia Do Programador
Cisco Prime Home – Integration Guide
OL-28557-01 v5.0.1
6
and Restlet are good choices. Select a tool to manipulate JSON formatted data
structures. A straight text editor will do. TextMate and E Text Editor
), jEdit, and notepad++ are good choices.
cURL (
) and a text editor will be used for
the examples in this guide.
Searching the API
In Prime Home 3.0, CAQL (ClearAccess Query Language) is used with the search
web service to find objects to manipulate with other web service endpoints.
The properties returned for each item don't necessarily map directly to the
search query. for example: querying 'subscriberCode' returns as 'code'.
Devices and Subscribers
Devices and subscribers are the primary objects managed by Prime Home. A
device is managed by Prime Home. It identifies itself with an OUI and Serial
Number. While many devices have a unique MAC address, the MAC is not used
for identification purposes (though, some devices have a serial number that is
the same as the MAC). It is critical to keep this in mind when integrating with
Prime Home. When creating a device using the integration APIs, the OUI and
Serial Number are the minimal amount of data required. A subscriber is a
person (or account) who has devices. It is externally identified by a subscriber
code. The format and contents of this code are determined by the integrator
and may map to a phone number, billing account number, or some other
unique value which has meaning in other systems.
Applications & Drivers
Figure 1
Prime Home is a platform for executing applications against devices in order to
apply some configuration. An application is a cohesive set of device functionality
and configuration. An example of this would be Time Blocking or Wireless.
Applications some or all of:
• Name & ID