Руководство РазработчикаСодержаниеPreface5Getting Started5Applications & Drivers6Services7HTTP/1.1 200 OK11Headers11Body11Methods11API Standards13URIs13Tables of Contents13Documents13WADL15Status Codes15Dates15Overview16About Search16Language Specification17Case Sensitivity17Terms17Specifying Document Type17Wildcards18Combining Terms19In Clause19Phrases19Ranged Searches19Precedence and Grouping19Not20Field Types20Showing Fields21Sorting21Zero-Term Queries22API Catalog23Provisioning & Management23Devices23Subscribers27When Working with Documents29Subscriber31Subscriber.Address.{}31Subscriber.Phone.{}31Example Format32Request32Response32Sample Code32HttpConfiguration.scala33JSONHelpers.scala33Use Case35Request35Response35Code36Use Case40Method40HTTP Interaction40Request40Response40Request40Response40Request41Response41Request41Response41Request41Response41Request42Response42Request43Response43Request43Response43Request43Response44Request45Response45Request45Response45Request46Response46Request47Response47Request47Response47Request49Response49Request49Response49Request50Response50Request51Response51Request51Response51Request52Response52DeviceActions.scala53DeviceData.scala54Use Case61Method61HTTP Interaction (Web Services)61Request61Response61HTTP Interaction (Browser)62Sample Code62Changing SSID with CURL66Working with Subscribers in Java67com.clearaccess.subscriber.Example67com.clearaccess.subscriber.api.SubscriberAPI68com.clearaccess.subscriber.api.Subscriber70com.clearaccess.subscriber.api.Address72com.clearaccess.subscriber.api.Credentials74com.clearaccess.Configuration75com.clearaccess.rest.RestClient76c77BNF78Размер: 893,7 КБСтраницы: 78Язык: EnglishПросмотреть
Руководство РазработчикаСодержаниеPreface5Getting Started5Applications & Drivers6Services7HTTP/1.1 200 OK11Headers11Body11Methods11API Standards13URIs13Tables of Contents13Documents13WADL15Status Codes15DTO Properties15Dates15Overview16About Search16Language Specification17Case Sensitivity17Terms17Specifying Document Type17Wildcards18Combining Terms19In Clause19Phrases19Ranged Searches19Precedence and Grouping19Not20Field Types20Showing Fields21Sorting21Zero-Term Queries22API Catalog23Provisioning & Management23Devices23Subscribers27When Working with Documents29Subscriber31Subscriber.Address.{}31Subscriber.Phone.{}31Example Format32Request32Response32Sample Code32HttpConfiguration.scala33JSONHelpers.scala33Use Case35Request35Response35Code36Use Case40Method40HTTP Interaction40Request40Response40Request40Response40Request41Response41Request41Response41Request41Response41Request42Response42Request43Response43Request43Response43Request43Response44Request45Response45Request45Response45Request46Response46Request47Response47Request47Response47Request49Response49Request49Response49Request50Response50Request51Response51Request51Response51Request52Response52DeviceActions.scala53DeviceData.scala54Use Case61Method61HTTP Interaction (Web Services)61Request61Response61HTTP Interaction (Browser)62Sample Code62Changing SSID with CURL66Working with Subscribers in Java67com.clearaccess.subscriber.Example67com.clearaccess.subscriber.api.SubscriberAPI68com.clearaccess.subscriber.api.Subscriber70com.clearaccess.subscriber.api.Address72com.clearaccess.subscriber.api.Credentials74com.clearaccess.Configuration75com.clearaccess.rest.RestClient76c77BNF78Размер: 895,4 КБСтраницы: 78Язык: EnglishПросмотреть
Руководство РазработчикаСодержание1 Preface51.1 Intended Audience51.2 In This Guide…51.3 Prime Home API Capabilities51.3.1 Device Management:51.3.2 Search:51.3.3 Create Control Panel Sessions:52 Getting Started52.1 Language / Framework Requirements52.2 Searching the API62.3 Devices and Subscribers63 Applications & Drivers64 Services75 Introduction to Device Lifecycle85.1 Provisioning85.2 Activation85.3 Management95.4 Termination96 REST106.1 Anatomy of a REST Call106.1.1 Request10POST /person/bjones HTTP/1.110Host: people.mydomain.com10Accept: application/json, text/xml;q=9, */*;q=810Content-Type: application/json10{10name: "Bob Jones",10age: 3010}10[VERB] [resource uri] [http version]10[headers]10[\n]10[body]106.1.2 Headers10Host: people.mydomain.com10Accept: application/json, text/xml;q=9, /;q=810Content-Type: application/json116.1.3 Body116.1.4 Response11HTTP/1.1 200 OK11Content-Type: application/json11Content-Length: 3411{11name: "Bob Jones",11age: 3011}11[http version] [status number] [status text]11[headers]11[\n]11[body]116.1.5 HTTP/1.1 200 OK116.1.6 Headers11Content-Length: 34116.1.7 Body116.1.8 Methods116.1.9 References126.2 Types of Resources126.2.1 Single Item126.2.2 Lists126.2.3 Processes126.3 Compared with SOAP126.4 JSON127 API Standards137.1 URIs137.2 Table of Contents137.3 Documents137.3.1 Modifying a Document147.3.2 Creating a New Document147.3.3 Deleting a Document147.3.4 WADL147.3.5 Status Codes14400 ERROR-CODE; Error Text157.3.6 DTO Properties157.3.7 Dates157.3.8158 Overview169 About Search1610 Language Specification1710.1 Case Sensitivity1711 CAQL Tutorial1711.1 Terms17name: juniper1711.2 Specifying Document Type17anything with juniper1811.3 Wildcards18with sn:ABC*18devices with sn:ABC????18devices with sn:ABC*XYZ18devices with sn:*XYZ18devices with wanip: 192.1.*.*1811.4 Combining Terms19devices with sn:1000* and oui:10*1911.5 In Clause19subscribers with name in ( sam juni )19subscribers with name: sam or name: juni1911.6 Phrases19subscribers with name: "juniper jones"1911.7 Ranged Searches19devices with informCount: from 1 to 10019devices with informCount: from 1001911.8 Precedence and Grouping19serialNumber:1000* and sam or juni19serialNumber:1000* and (sam or juni)2011.9 Not20not sam20subscribers with name: not sam20subscribers with name: not in (sam juni)2011.10 Field Types20devices with downstreamAttenuation: from 1.0 to 1.521devices with firstInform: from 2/14/201021devices with wanip: 1.2.3.*21device with serialNumber: 1234521device with serialNumber: "12345"2111.11 Showing Fields21devices with oui: AA1122 show serialNumber lastInform21devices with oui: AA1122 show serialNumber as "Serial Number" lastInform as "Last Inform Date"2111.12 Sorting21devices with oui: AA1122 sort lastInform21devices with oui: AA1122 sort lastInform desc22devices with oui: AA1122 sort lastInform desc serialNumber2211.13 Zero-Term Queries22devices22devices show serialNumber sort lastInform2212 API Catalog2312.1 Full Text Search2313 Provisioning & Management2313.1 Devices2313.2 Subscribers27subscriber.credentials = {};2814 When Working with Documents2914.1 Revision Conflict29HTTP/1.1 400 revision is out of date; provided=86183852, existing=861838532914.2 Invalid Data29{29"id":"1234"29}2914.3 JSON Formatting30Subscriber31Subscriber.Address.{}31Subscriber.Phone.{}3115 Example Format3215.1 Use Case3215.2 Method3215.3 HTTP Interaction3215.3.1 Request3215.3.2 Response3215.3.3 Sample Code3215.4 Utilities Used by the Examples3315.4.1 HttpConfiguration.scala3315.4.2 JSONHelpers.scala3316 Use Case3516.1 Method3516.2 HTTP Interaction3516.2.1 Request3516.2.2 Response3516.3 Code3616.3.1 SearchService.scala3616.3.2 SearchResult.scala3616.3.3 SearchUseCase.scala3817 Use Case3918 Method3919 HTTP Interaction3919.1 Creating the Subscriber3919.1.1 Request3919.1.2 Response3919.1.3 Request3919.1.4 Response39Finding / Creating a Device4019.1.5 Request4019.1.6 Response4019.1.7 Request4019.1.8 Response4019.1.9 Request4019.1.10 Response4019.1.11 Request4119.1.12 Response4119.2 Enabling Services4219.2.1 Request4219.2.2 Response4219.2.3 Request4219.2.4 Response4219.2.5 Request4219.2.6 Response4319.3 Updating an Application4419.3.1 Request4419.3.2 Response4419.3.3 Request4419.3.4 Response4419.3.5 Request4519.3.6 Response4619.3.7 Request4719.3.8 Response4719.3.9 Request4719.3.10 Response4819.4 Replacing & Deleting a Device4919.4.1 Request4919.4.2 Response4919.4.3 Request4919.4.4 Response4919.4.5 Request5019.4.6 Response5019.4.7 Request5119.4.8 Response5119.4.9 Request5119.4.10 Response5119.4.11 Request5219.4.12 Response5219.5 Sample Code5319.5.1 DeviceActions.scala5319.5.2 DeviceData.scala5419.5.3 DeviceService.scala5519.5.4 LifeCycleUseCases.scala5820 Use Case6121 Method6122 HTTP Interaction (Web Services)6122.1 Obtaining the Single Sign-On Session Information6122.1.1 Request6122.1.2 Response6123 HTTP Interaction (Browser)621. GET /acs-portal/control-panel/login?cpSessionId=527BBB943DAAE583862D11298EAC8442DABD3BC2A0&device=001A2B:001A2B999999, confirms the session and configures the browser's cookies, forwarding them to the control panel UI, if all is good.622. GET /acs-portal/controlpanel?62cpSessionId=527BBB943DAAE5838D11298EAC8442DABD3BC2A0&device=001A2B:001A2B999999, the actual control panel UI.6223.1 Sample Code6223.1.1 ControlPanelSessionService.scala6223.1.2 AuthBridgeHttpRequestHandler.scala6324 Working with Subscribers in Java6524.1 Introduction6524.2 Main Example6524.2.1 com.clearaccess.subscriber.Example6524.3 Interaction with the API6624.3.1 com.clearaccess.subscriber.api.SubscriberAPI6624.4 Data Classes6824.4.1 com.clearaccess.subscriber.api.Subscriber6824.4.2 com.clearaccess.subscriber.api.Address7024.4.3 com.clearaccess.subscriber.api.Credentials7224.5 Support7324.5.1 com.clearaccess.Configuration7324.5.2 com.clearaccess.rest.RestClient7424.5.3 com.clearaccess.rest.HttpClientFactory7525 Changing SSID at index 1 with CURL7625.1 Introduction7625.2 Main Example76Размер: 898,0 КБСтраницы: 77Язык: EnglishПросмотреть