ISL Online Web API Documentation

Transcription

1 ISL Online Web API Documentation

2 ISL Online Web API Documentation Contents 2 Table of Contents Foreword 0 Part I Overview 4 Part II Communication model 5 Part III Methods account/passw ord/change/ account/hosted/domain/set/ account/passw ord/forgot/ account/signup/ account/signup/tw ostep/ content/brochure/languages/get/ content/brochure/get/ content/resellers/get/ content/shop/items/get/ localization/translation/resources/get/ localization/translation/single/get/ localization/translation/single/insert/ report/accounthistory/status/get/ report/groop/session/details/get/ report/groop/sessions/overview/get/ report/groop/sessions/overview/usage/get/ report/license/usage/get/ report/light/sessions/overview/get/ report/light/sessions/overview/usage/get/ report/ppu/status/get/ report/pronto/chat/overview/get/ report/pronto/supporters/overview/get/ report/pronto/overview/hours/get/ report/pronto/overview/filters/get/ report/pronto/messages/offline/get/ sso/login/ sso/login/get/1 43 Part IV jquery plugin v

3 ISL Online Web API Documentation Contents 3 Index 0 3

4 ISL Online Web API Documentation Overview 4 1 Overview This document is intended for developers who want to write applications or web sites for interacting with ISL Online Account API. If you are unfamiliar with API concept, you should read through this documentation and examples before starting to code. User API provides only public methods that do not require any authentication for accessing them.

5 ISL Online Web API Documentation Communication model 5 2 Communication model User API communicates via HTTP protocol and provides 3 ways of communication (/GET, JSON(P) and XML). Apart from 4 general communication fields, that must be sent via GET, all other data can be sent in any way. We strongly encourage the use of over GET method for sending data (except in the case of JSONP). All data sent via or GET should be URL encoded! Available fields: method - method you wish to call. This field is mandatory! he - defines encoding of communication. By defining this setting, you define in what way would you like to receive response data from the API. Current version supports JSON1, XML1. This field is mandatory! hl - defines language. Value must be a ISO code. Language defines the language in which response message should be returned. If message is not yet translated, English version will be returned. hc - defines country. Value must be a ISO Alpha-2 code. Country setting defines country specifics that API might have. Response objects: JSON1 and XML1 JSON1 is version 1 of JSON response defined by ISL Online API protocol. Response object has following structure: method: which method was called response: the response values - result: this object hold all method result values/fields - description: translated message that can be shown to user - code: predefined message codes (look below) - args: arguments which correspond to message code; it can be in a following formats:

6 ISL Online Web API Documentation Communication model 6 - key-value pair: "data": "returned data value" - array: "data": ["array", "of", "values"] - data: various data which is method specific; it can be in any JSON valid format: - key-value pair: "data": "returned data value" - array: "data": ["array", "of", "values"] - object: "data": { "returned": "item" } JSON1 structure: j son={ " met hod" : " met hod_name", " r esponse" : { " r esul t " : { " descr i pt i on" : " gener at ed descr i pt i on", " descr i pt i on_or i g" : " gener at ed non- t r ansl at ed descr i pt i on", " code" : " r esul t _code", " ar gs" : " ar gument _key" OR [ " ar r ay", " of ", " ar gument s" ] }, " dat a" : " val ue" OR [ " ar r ay", " of ", " val ues" ] OR { " r et ur ned" : " val ue" } } } XML1 structure: <?xml ver si on=" 1. 0" encodi ng=" ut f - 8"?> <api > <met hod>met hod_name</ met hod> <r esponse> <r esul t > <descr i pt i on>gener at ed descr i pt i on</ descr i pt i on> <code>r esul t _code</ code> <ar gs>ar r ay</ ar gs> <ar gs>of </ ar gs> <ar gs>ar gument s</ ar gs> </ r esul t > <dat a>r et ur ned val ue</ dat a> <dat a>r et ur ned val ue</ dat a> </ r esponse> </ api > API Messages A part of response object is result code, which holds one of the predefined values:

7 ISL Online Web API Documentation Communication model 7 Method executed without any exceptions: code: OK - all methods were executed without any problems. User input/procedure errors (this is normal no need to fix implementation and usage of API - developer should handle this errors and show description to user): code: USER_ERROR Usage errors (developer did something wrong and should fix the error by reading documentation and following samples) code: IMPLEMENTATION_ERROR Internal errors (something went wrong on server - API developers will fix this errors. When spotted they should be reported back to support@islonline.com) code: INTERNAL_ERROR

8 ISL Online Web API Documentation Methods 8 3 Methods Here are described all the methods supported by User API, their input fields and their output. Methods are generally divided into categories and subcategories. 3.1 account/password/change/1 Changes password for user with sent UID. Password is set to password parameter value. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i ne- account. php? met hod=account / passwor d/ change/ 1 e ma i l _ a d d r e s s [ s t r i n g ] ( r e q u i r e d ) u i d [ s t r i n g ] ( r e q u i r e d ) p a s s wo r d [ s t r i n g ] ( r e q u i r e d ) r a n d o m [ s t r i n g ] ( r e q u i r e d ) None emai l _addr ess: e. com ui d: domai n: : e. com: : mai n passwor d: secr et r andom: ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / passwor d/ change/ 1&he=JSON1 : emai l _addr e. com&ui d=domai n: : e. com: : mai n&passwor d=

9 ISL Online Web API Documentation Methods 9 secr et &r andom= ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / passwor d/ change/ 1&he=JSON1 : j son={ " emai l _addr ess" : " e. com", " ui d" : " domai n: : e. com: : mai n", " passwor d" : " secr et ", " r andom" : " " } 3.2 account/hosted/domain/set/1 Changes the account's domain name for hosted service. If account does not yet have a ISL domain, the domain with passed name will be created. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i ne- account. php? met hod=account / host ed/ domai n/ set / 1 d o ma i n _ n a me [ s t r i n g ] ( r e q u i r e d ) u i d [ s t r i n g ] ( r e q u i r e d ) t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod None domai n_name: my domai n ui d: domai n: : e. com: : mai n t oken: secr et ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / host ed/ domai n/ set / 1&he=JSON1

10 ISL Online Web API Documentation Methods 10 : domai n_name=mydomai n&ui d=domai n: : e. com: : mai n&t oken=secr et ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / passwor d/ change/ 1&he=JSON1 : j son={ " domai n_name" : " mydomai n", " ui d" : " domai n: : e. com: : mai n", " t oken" : " secr et " } 3.3 account/password/forgot/1 Sends with account details to user registered with provided address. Description The call will generate an with link to reset password and send it to the emai l _addr ess. Exception: When setting hl=ja (japanese language) it will work as old password forgot and resend old with authentication details. Now it works like this it will send username and password for: - If address match www account address (from registration) - If address of additional user matches ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i ne- account. php? met hod=account / passwor d/ f or got / 1 e ma i l _ a d d r e s s [ s t r i n g ] ( r e q u i r e d )

11 ISL Online Web API Documentation Methods 11 None emai l _addr ess: e. com ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / passwor d/ f or got / 1&he=JSON1 : emai l _addr e. com ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / passwor d/ f or got / 1&he=JSON1 : j son={ " emai l _addr ess" : " e. com" } 3.4 account/signup/1 Returns the result of single step sign up procedure. hc and hl are required for signup. If values are not set, they will be detected automatically. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i ne- account. php? met hod=account / si gnup/ 1 u s e r _ n a me [ s t r i n g ] ( r e q u i r e d ) p a s s wo r d [ s t r i n g ] ( r e q u i r e d ) o r i g i n [ o b j e c t ] i nf or mat i on about t he user r e s e l l e r I d [ i n t e g e r ] i f no val ue i s set, HQ r esel l er i d i s set a r i d [ i n t e g e r ] l ook at r esel l er I d

12 ISL Online Web API Documentation Methods 12 None user _name: e. com passwor d: secr et ar i d: or i gi n: { " appcodename" : " Mozi l l a", " appmi nor Ver si on" : " undef i ned", " appname" : " Net scape", " appver si on" : " 5. 0 ( Wi ndows) ", " cooki eenabl ed" : " t r ue", " cpucl ass" : " undef i ned", " onli ne" : " t r ue", " p l at f or m" : " Wi n32", " syst emlanguage" : " undef i ned", " user Agent " : " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ ", " user Language" : " undef i ned" } ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ 1&he=JSON1 user e. com, passwor d=secr et, r esel l er I d=333133, or i gi n= " { \ " appcodename\ " : \ " Mozi l l a\ ", \ " appmi nor Ver si on\ " : \ " undef i ned\ ", \ " appname \ " : \ " Net scape\ ", \ " appver si on\ " : \ " 5. 0 ( Wi ndows) \ ", \ " cooki eenabl ed\ " : \ " t r ue \ ", \ " cpucl ass\ " : \ " undef i ned\ ", \ " onli ne\ " : \ " t r ue\ ", \ " pl at f or m\ " : \ " Wi n32\ ", \ " syst emlanguage\ " : \ " undef i ned\ ", \ " user Agent \ " : \ " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ \ ", \ " user Language\ " : \ " undef i ned\ " } " ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ 1&he=JSON1 : j son={ " user _name" : " e. com", " passwor d" : " secr et ", " ar i d" : " ", " or i gi n" : " { \ " appcodename\ " : \ " Mozi l l a\ ", \ " appmi nor Ver si on\ " : \ " undef i ned\ ", \ " appname\ " : \ " Net scape\ ", \ " appver si on\ " : \ " 5. 0 ( Wi ndows) \ ", \ " cooki eenabl ed\ " : \ " t r ue\ ", \ " cpucl ass\ " : \ " undef i ned\ ", \ " onli ne\ " : \ " t r ue\ ", \ " pl at f or m\ " : \ " Wi n32\ ", \ " syst emlanguage\ " : \ " undef i ned \ ", \ " user Agent \ " : \ " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ \ ", \ " user Language\ " : \ " undef i ned\ " } " } 3.5 account/signup/twostep/1 Returns the result of a two step sign up procedure. hc and hl are required for signup. If values are not set, they will be detected automatically.

13 ISL Online Web API Documentation Methods 13 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i ne- account. php? met hod=account / si gnup/ t wost ep/ 1 St e p 1 : e ma i l _ a d d r e s s [ s t r i n g ] ( r e q u i r e d ) s t e p [ i n t e g e r ] ( r e q u i r e d ) s h o u l d h a v e v a l u e 1 St e p 2 : u s e r _ n a me [ s t r i n g ] ( r e q u i r e d ) s t e p [ i n t e g e r ] ( r e q u i r e d ) s h o u l d h a v e v a l u e 2 p a s s wo r d [ s t r i n g ] ( r e q u i r e d ) r a n d o m [ s t r i n g ] ( r e q u i r e d ) c o u n t r y _ c o d e [ s t r i n g ] ( r e q u i r e d ) o r i g i n [ o b j e c t ] ( r e q u i r e d ) a r i d [ i n t e g e r ] ( r e q u i r e d ) c o mp a n y f u l l _ n a me p h o n e _ n u mb e r None St e p 1 : emai l _addr ess: e. com st ep: 1 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1 : user e. com, st ep=1 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1 : j son={ " user _name" : " e. com", " st ep" : " 1" } St e p 2 :

14 ISL Online Web API Documentation Methods 14 user _name: e. com passwor d: secr et st ep: 2 r andom: count r y_code: ES or i gi n: { " appcodename" : " Mozi l l a", " appmi nor Ver si on" : " undef i ned", " appname" : " Net scape", " appver si on" : " 5. 0 ( Wi ndows) ", " cooki eenabl ed" : " t r ue", " cpucl ass" : " undef i ned", " onli ne" : " t r ue", " p l at f or m" : " Wi n32", " syst emlanguage" : " undef i ned", " user Agent " : " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ ", " user Language" : " undef i ned" } ar i d: c ompany: My Company f ul l _name: Ful l Name phone_number : GET ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1&user _name=user % 40exampl e. com&passwor d=secr et &st ep=2&r andom= &count r y_code=es&compan y =My%20Company&f ul l _name=ful l %20Name&phone_number =%2B1%2023% &ar i d=333133&or i gi n=%7b%22appcodename%22%3a%22moz i l l a%22%2c%20% 22appMi nor Ver s i on%22%3a%20%22undef i ned%22%2c%22appname%22%3a%22net s c ape%22% 2C%22appVer s i on%22%3a%225. 0%20( Wi ndows) %22%2C%22c ook i eenabl ed%22%3a%22t r ue% 22%2C%22c pucl as s%22%3a%22undef i ned%22%2c%22onli ne%22%3a%22t r ue%22%2c% 22pl at f or m%22%3a%22wi n32%22%2c%22s y s t emlanguage%22%3a%22undef i ned%22%2c% 22us er Agent %22%3A%22Moz i l l a%2f5. 0%20( Wi ndows%20nt%206. 1%3B%20WOW64%3B%20r v% 3A ) %20Gec k o%2f %20fi r ef ox%2f %22%2C%22us er Language%22%3A% 22undef i ned%22%7d ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1 : user e. com, passwor d=secr et, st ep=2, r andom= , count r y_code=es, or i gi n={ \ " appcodename\ " : \ " Mozi l l a\ ", \ " appmi nor Ver si on\ " : \ " undef i ned\ ", \ " appname\ " : \ " Net scape\ ", \ " appver si on\ " : \ " 5. 0 ( Wi ndows) \ ", \ " cooki eenabl ed\ " : \ " t r ue\ ", \ " cpucl ass\ " : \ " undef i ned\ ", \ " onli ne\ " : \ " t r ue\ ", \ " pl at f or m\ " : \ " Wi n32\ ", \ " syst emlanguage\ " : \ " undef i ned \ ", \ " user Agent \ " : \ " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ \ ", \ " user Language\ " : \ " undef i ned\ " }, ar i d=333133, c ompany =My Company, f ul l _name=ful l Name, phone_number = JSON GET ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1&j son%3d%7b%20% 22us er _name%22%20%3a%20%22us er %40ex ampl e. c om%22%2c%20%22pas s wor d%22%20%3a% 20%22s ec r et %22%2C%20%22s t ep%22%20%3a%20%222%22%2c%20%22r andom%22%20%3a%20% %22%2C%20%22c ount r y_c ode%22%20%3a%20%22es%22%2c%20%22ar i d%22%20% 3A%20% %22%2C%20%22c ompany%22%20%3a%20%22my%20company%22%2c%20% 22f ul l _name%22%20%3a%20%22ful l %20Name%22%2C%20%22phone_number %22%20%3A%20% 22%2B1%2023% %22%2C%20%22or i gi n%22%20%3a%20%22%%7b%22appcodename% 22%3A%22Moz i l l a%22%2c%20%22appmi nor Ver s i on%22%3a%20%22undef i ned%22%2c% 22appName%22%3A%22Net s c ape%22%2c%22appver s i on%22%3a%225. 0%20( Wi ndows) %22%2C %22c ook i eenabl ed%22%3a%22t r ue%22%2c%22c pucl as s%22%3a%22undef i ned%22%2c% 22onLi ne%22%3a%22t r ue%22%2c%22pl at f or m%22%3a%22wi n32%22%2c%22s y s t emlanguage %22%3A%22undef i ned%22%2c%22us er Agent %22%3A%22Moz i l l a%2f5. 0%20( Wi ndows%20nt% %3B%20WOW64%3B%20r v%3a ) %20Gec k o%2f %20fi r ef ox%2f % 22%2C%22us er Language%22%3A%22undef i ned%22%7d ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- account / 1-0/ i sl onl i neaccount. php?met hod=account / si gnup/ t wost ep/ 1&he=JSON1 : j son={ " user _name" : " e. com", " passwor d" : " secr et ", " st ep" : " 2", " r andom" : " ", " count r y_code" : " ES", " ar i d" : " ", " company" : " My Company", " f ul l _name" : " Ful l Name", " phone_number " : " ", " or i gi n" : " { \ " appcodename\ " : \ " Mozi l l a \ ", \ " appmi nor Ver si on\ " : \ " undef i ned\ ", \ " appname\ " : \ " Net scape\ ",

15 ISL Online Web API Documentation Methods 15 \ " appver si on\ " : \ " 5. 0 ( Wi ndows) \ ", \ " cooki eenabl ed\ " : \ " t r ue\ ", \ " cpucl ass\ " : \ " undef i ned\ ", \ " onli ne\ " : \ " t r ue\ ", \ " pl at f or m\ " : \ " Wi n32\ ", \ " syst emlanguage \ " : \ " undef i ned\ ", \ " user Agent \ " : \ " Mozi l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v: ) Gecko/ Fi r ef ox/ \ ", \ " user Language\ " : \ " undef i ned\ " } " } 3.6 content/brochure/languages/get/1 Returns available brochure languages and their website paths. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i ne- cont ent. php? met hod=cont ent / br ochur e/ l anguages/ get / 1 y e a r [ i n t e g e r ] J SON d a t a o b j e c t l anguages - key- val ue par, wher e key i s l anguage code and val ue i s pat h t o br ochur e year : 2012 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i necont ent. php?met hod=cont ent / br ochur e/ l anguages/ get / 1&he=JSON1 : y ear =2012 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- sso/ 1-0/ i sl onl i ne- sso. php? met hod=cont ent / br ochur e/ l anguages/ get / 1&he=JSON1 : j son={ " year " : " 2012" }

16 ISL Online Web API Documentation Methods content/brochure/get/1 This is a binary dump API. Rather then returning url to PDF it serves the PDF file as mime type application/pdf. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i ne- cont ent. php? met hod=cont ent / br ochur e/ get / 1 y e a r [ i n t e g e r ] ( r e q u i r e d ) l a n g u a g e [ s t r i n g ] ( r e q u i r e d ) t y p e [ s t r i n g ] i f i t i s set t o pr emi um, a pr emi um br ochur e wi l l be r et ur ned PDF b i n a r y f i l e s e r v e d wi t h mi me t y p e a p p l i c a t i o n / p d f year : 2012 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i necont ent. php?met hod=cont ent / br ochur e/ get / 1&he=JSON1 : y ear =2012&l anguage=en ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- sso/ 1-0/ i sl onl i ne- sso. php? met hod=cont ent / br ochur e/ get / 1&he=JSON1 : j son={ " year " : " 2012", " l anguage" : " en" } 3.8 content/resellers/get/1 Returns available brochure languages and their website paths.

17 ISL Online Web API Documentation Methods 17 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i ne- cont ent. php? met hod=cont ent / r esel l er s/ get / 1 One of t he ar gument s i s r equi r ed a r i d [ i n t e g e r ] r et ur ns onl y dat a of r esel l er wi t h passed RI D c o u n t r y _ c o d e [ s t r i n g ] r et ur ns l i st of r esel l er s f or speci f i c count r y J SON d a t a o b j e c t r esel l er s sor t ed_name - obj ect wi t h r esel l er ' s i nf o ar i d - r esel l er ' s I D l abel - r esel l er ' s name cont act _det ai l s - obj ect wi t h r esel l er ' s cont act det ai l s avai l abl e f i el ds ( al l f i el ds ar e not r equi r ed f or al l r esel l er s) : appoi nt ment - appoi nt ed count r y name - f ul l r esel l er ' s name hr ef - r esel l er ' s web si t e f ul l _addr ess - r esel l er ' s addr ess emai l - r esel l er ' s cont act emai l addr ess t el ephone - r esel l er ' s phone number t el ef ax - r esel l er ' s t el ef ax number vat _i d - r esel l er ' s VAT number sel ect ed - i f r esel l er shoul d be pr esel l ect ed count r y_code: US ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i necont ent. php?met hod=cont ent / r esel l er s/ get / 1&he=JSON1

18 ISL Online Web API Documentation Methods 18 : count r y_code=us ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- sso/ 1-0/ i sl onl i ne- sso. php? met hod=cont ent / r esel l er s/ get / 1&he=JSON1 : j son={ " count r y_code" : " US" } 3.9 content/shop/items/get/1 Returns list of all available items in shop with prices. Method also returns how price should be formated for specified country and what is correct currency code. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i ne- cont ent. php? met hod=cont ent / shop/ i t ems/ get / 1 c o u n t r y _ c o d e [ s t r i n g ] ( r e q u i r e d ) count r y code shoul d be i n t he f or m of upper cased t wo l et t er code ( I SO al pha- 2). The r esul t wi l l be count r y speci f i c ( cur r ency, pr i ces,... ) n o d e c i ma l [ b o o l e a n ] ( r e q u i r e d ) i f pr i ces wi t hout deci mal pl aces i s r equi r ed t hi s shoul d be set t o t r ue. Def aul t val ue i s f al se J SON d a t a o b j e c t cur r ency_symbol - count r y' s cur r ency code cur r ency_symbol _i n_f r ont - i f i s set t o t r ue, t he cur r ency code i s wr i t t en bef or e t he pr i ce cur r ency_deci mal - char act er used t o seper at e deci mal pl aces cur r ency_di gi t _gr oupi ng_symbol - char act er used t o t housands, mi l l i ons et c. cur r ency_di gi t s_af t er _deci mal - how many deci mal pl aces pr i ce shoul d have i t ems i t em_code - shop i t em code det ai l ed_descr i pt i on - i t em' s l ong descr i pt i on shor t _descr i pt i on - i t em' s shor t descr i pt i on f i l t er - t o whi ch gr oup i t em bel ongs sku - i t em' s SKU code pr i ce_numer i c - pr i ce i n t he f or m of number

19 ISL Online Web API Documentation Methods 19 pr i ce_di spl ay - pr i ce f or mat ed f or di spl ay quant i t y_par ams - det ai l s about quant i t y, dur at i on, di scount s et c. count r y_code: US ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- cont ent / 1-0/ i sl onl i necont ent. php?met hod=cont ent / shop/ i t ems/ get / 1&he=JSON1 : count r y_code=us ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- sso/ 1-0/ i sl onl i ne- sso. php? met hod=cont ent / shop/ i t ems/ get / 1&he=JSON1 : j son={ " count r y_code" : " US" } 3.10 localization/translation/resources/get/1 Returns list of all resources and their translation/localization status. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod p a r t n e r _ c o d e [ s t r i n g ] ( r e q u i r e d ) par t ner code pr ovi ded t o you by I SL Onl i ne l a n g u a g e _ c o d e [ s t r i n g ] ( r e q u i r e d ) I SO l anguage code; t hi s def i nes l ocal i zat i on l anguage o f f s e t [ i n t e g e r ] of f set 100 means t hat r esul t s wi l l be shown f r om 100t h r esul t on l i mi t [ i n t e g e r ] how many r esul t s ar e shown i n r esponse; maxi mum number i s 100 s o r t [ k e y - v a l u e p a i r a r r a y ] def i nes how r esul t s shoul d be sor t ed; f i r st val ue shoul d be f i el d name, second shoul d be sor t di r ect i on;

20 ISL Online Web API Documentation Methods 20 i f mul t i pl e sor t f i el ds ar e passed, t hey wi l l be par sed i n or der i n whi ch t hey r esi de i n ar r ay ( FI FO) Suppor t ed f i el ds: r esour ce_i d pr ogr am_name cont ext t r ansl at abl e_st r i ngs unt r ansl at ed_st r i ngs wor d_count Suppor t ed di r ect i ons: ASC - f or ascendi ng DESC - f or descendi ng f i l t e r [ k e y - v a l u e p a i r a r r a y ] def i nes how r esul t s shoul d be f i l t er ed; f i r st val ue shoul d be f i el d name, second shoul d be f i el d val ue; i f mul t i pl e f i el ds ar e passed AND l ogi cal oper at or wi l l be put bet ween t hem Suppor t ed f i el ds: modul e_name [ st r i ng] - execut es case i nsensi t i ve l ef t and r i ght sear ch ( SL wi l l mat ch al so I SL Onl i ne) pr ogr am_name [ st r i ng] - execut es case i nsensi t i ve l ef t and r i ght sear ch ( SL wi l l mat ch al so I SL Onl i ne) cont ext [ st r i ng] - execut es case i nsensi t i ve l ef t and r i ght sear ch ( SL wi l l mat ch al so I SL Onl i ne) pl ugi n_name [ st r i ng] - execut es case i nsensi t i ve l ef t and r i ght sear ch ( SL wi l l mat ch al so I SL Onl i ne) t r ansl at i on_ver si on [ st r i ng] - execut es exact sear ch ( 1. 1 wi l l not mat ch , but onl y 1. 1, al so 1. 1A wi l l not mat ch 1. 1a) t r ansl at ed [ bool ean] - i f t r ansl at ed i s set t o t r ue onl y r esour ces f ul l y t r ansl at ed wi l l be shown J SON d a t a o b j e c t r esour ces - ar r ay of r esour ces avai l abl e f or t r ansl at i on r esour ce_i d: i d of r esour ce modul e_name: t o whi ch modul e t r ansl at i on r ef er s pr ogr am_name: t o whi ch pr ogr am t r ansl at i on r ef er s cont ext : t o whi ch cont ext t r ansl at i on i s r el at ed pl ugi n_name: t o whi ch pl ugi n t r ansl at i on r ef er s t r ansl at i on_ver si on: t r ansl at i on ver si on t r ansl at abl e_st r i ngs: number of st r i ngs t hat can be t r ansl at ed unt r ansl at ed_st r i ngs: number of unt r ansl at ed st r i ngs wor d_count : number of wor ds t hat can be t r ansl at ed

21 ISL Online Web API Documentation Methods 21 EXAMPLE 1 ui d: : : e. com: : mai n t oken: secr et par t ner _code: par t ner - code l anguage_c ode: es of f set : 6 l i mi t : 3 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, par t ner _code=par t ner - code, l anguage_code=es, of f set =6, l i mi t =3 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " par t ner _code" : " par t ner - code", " l anguage_code" : " es", " of f set " : " 6", " l i mi t " : " 3" } EXAMPLE 2: When usi ng sor t or f i l t er par amet er s, JSON GET or met hod must be used! ui d: : : e. com: : mai n t oken: secr et par t ner _code: par t ner - code l anguage_c ode: es of f set : 6 l i mi t : 3 sor t : r esour ce_i d=asc f i l t er : pr ogr am_name=l i ght, t r ansl at ed=f al se, t r ansl at i on_ver si on=1 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " par t ner _code" : " par t ner - code", " l anguage_code" : " es", " of f set " : " 6", " l i mi t " : " 3", " sor t " : { " r esour ce_i d" : " ASC" }, " f i l t er " : { " pr ogr am_name" : " l i ght ", " t r ansl at ed" : " f al se", " t r ansl at i on_ver si on" : " 1" } } 3.11 localization/translation/single/get/1 Returns list of all strings available for translation in a single resource. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ get / 1

22 ISL Online Web API Documentation Methods 22 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod p a r t n e r _ c o d e [ s t r i n g ] ( r e q u i r e d ) par t ner code pr ovi ded t o you by I SL Onl i ne l a n g u a g e _ c o d e [ s t r i n g ] ( r e q u i r e d ) I SO l anguage code; t hi s def i nes l ocal i zat i on l anguage r e s o u r c e _ i d [ i n t e g e r ] r esour ce i d, whi ch can be obt ai ned by cal l i ng l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1 met hod J SON d a t a o b j e c t t r ansl at i ons - ar r ay of t r ansl at i on st r i ngs r esour ce_i d: i d of r esour ce l anguage_code: t o whi ch l anguage t r ansl at i ons r ef er t r ansl at i ons: ar r ay of t r ansl at i ons st r i ngs or i gi nal _t ext : t ext exposed f or t r ansl at i on t r ansl at ed_t ext : cur r ent t r ansl at i on of or i gi nal t ext ui d: : : e. com: : mai n t oken: secr et par t ner _code: par t ner - code l anguage_c ode: es r esour ce_i d: 108 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, par t ner _code=par t ner - code, l anguage_code=es, r esour ce_i d=108 ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ get / 1&he=JSON1

23 ISL Online Web API Documentation Methods 23 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " par t ner _code" : " par t ner - code", " l anguage_code" : " es", " r esour ce_i d" : " 108" } 3.12 localization/translation/single/insert/1 Inserts new translation for given translation string in single resource. ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ i nser t / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod p a r t n e r _ c o d e [ s t r i n g ] ( r e q u i r e d ) par t ner code pr ovi ded t o you by I SL Onl i ne l a n g u a g e _ c o d e [ s t r i n g ] ( r e q u i r e d ) I SO l anguage code; t hi s def i nes l ocal i zat i on l anguage r e s o u r c e _ i d [ i n t e g e r ] r esour ce i d, whi ch can be obt ai ned by cal l i ng l ocal i zat i on/ t r ansl at i on/ r esour ces/ get / 1 met hod o r i g i n a l _ t e x t [ s t r i n g ] or i gi nal t ext, whi ch can be obt ai ned by cal l i ng l ocal i zat i on/ t r ansl at i on/ si ngl e/ get / 1 met hod t r a n s l a t e d _ t e x t [ s t r i n g ] new t r ansl at i on t ext ; cur r ent t r ansl at i on t ext can be obt ai ned by cal l i ng l ocal i zat i on/ t r ansl at i on/ si ngl e/ get / 1 met hod J SON d a t a o b j e c t t r ansl at i on - i nf or mat i on about what was updat ed r esour ce_i d: i d of r esour ce l anguage_code: t o whi ch l anguage t r ansl at i ons r ef er or i gi nal _t ext : t ext t hat was t r ansl at ed t r ansl at ed_t ext : new t r ansl at i on t ext

24 ISL Online Web API Documentation Methods 24 ui d: : : e. com: : mai n t oken: secr et par t ner _code: par t ner - code l anguage_c ode: es r esour ce_i d: 108 or i gi nal _t ext : Admi n mode t r ansl at ed_t ext : Admi ni st r at i ve mode ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ i nser t / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, par t ner _code=par t ner - code, l anguage_code=es, r esour ce_i d=108, or i gi nal _t ext =Admi n mode, t r ansl at ed_t ext =Admi ni st r at i ve mode ht t ps: / / www. i sl onl i ne. com/ api / i sl onl i ne- l ocal i zat i on/ 1-0/ i sl onl i nel ocal i zat i on. php?met hod=l ocal i zat i on/ t r ansl at i on/ si ngl e/ i nser t / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " par t ner _code" : " par t ner - code", " l anguage_code" : " es", " r esour ce_i d" : " 108", " or i gi nal _t ext " : " Admi n mode", " t r ansl at ed_t ext " : " Admi ni st r at i ve mode" } 3.13 report/accounthistory/status/get/1 Returns account's subscription status. met hod=r epor t / account hi st or y/ st at us/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod

25 ISL Online Web API Documentation Methods 25 J SON d a t a o b j e c t l hs_t ype_code: code of subscr i pt i on t ype l hs_t ype_descr i pt i on: subscr i pt i on t ype sub: subscr i pt i on ( t =t r ue/ yes, f =f al se/ no) sub_act i ve: i s subscr i pt i on st i l l act i ve ( t =t r ue/ yes, f =f al se/ no) sub_st ar t : subscr i pt i on st ar t dat et i me sub_st ar t _l ocal : subscr i pt i on st ar t dat et i me i n l ocal t i me sub_expi r e: subscr i pt i on expi r y dat et i me sub_expi r e_l ocal : subscr i pt i on expi r y dat et i me i n l ocal t i me sub_sessi on_max_concur r ent : number of l i censes i n subscr i pt i on sub_sessi on_max_cl i ent s: max. number of cl i ent s al l owed sub_mul t i _sessi on_l i cense: does subscr i pt i on i ncl ude mul t i sessi on l i cense ( t =t r ue/ yes, f =f al se/ no) sub_pr emi um_suppor t : does subscr i pt i on i ncl ude pr emi um suppor t ( t =t r ue/ yes, f =f al se/ no) sub_pl ugi n_vi deo: does subscr i pt i on i ncl ude vi deo pl ugi n ( t =t r ue/ yes, f =f al se/ no) sub_pl ugi n_audi o: does subscr i pt i on i ncl ude audi o pl ugi n ( t =t r ue/ yes, f =f al se/ no) ppu: does t hi s account i ncl ude Pay Per Use ( t =t r ue/ yes, f =f al se/ no) ppu_act i ve: i s Pay Per Use st i l l act i ve - can t he cr edi t s be used ( t =t r ue/ yes, f =f al se/ no) ppu_expi r e: Pay Per Use subscr i pt i on expi r y dat et i me ppu_expi r e_l ocal : Pay Per Use subscr i pt i on expi r y dat et i me i n l ocal t i me ppu_cr edi t s: how many Pay Per Use t i me i s l ef t on subscr i pt i on ( hh: mm: ss) ; i n case t her e i s no PPU t i me, t hi s val ue mi ght show - 00: 00: 01 ppu_cr edi t s_mi nut es: how many Pay Per Use t i me i n mi nut es i s st i l l avai l abl e on subscr i pt i on; i n case t her e i s no PPU t i me, t hi s val ue mi ght s how cur r ency_code: subscr i ber ' s cur r ency code ui d: : : e. com: : mai n t oken: secr et met hod=r epor t / account hi st or y/ st at us/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et met hod=r epor t / account hi st or y/ st at us/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et " }

26 ISL Online Web API Documentation Methods report/groop/session/details/get/1 Returns all details about a single ISL Groop session. met hod=r epor t / gr oop/ sessi on/ det ai l s/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod s e s s i o n _ i d [ s t r i n g ] ( r e q u i r e d ) J SON d a t a o b j e c t event s - ar r ay of user j oi n/ l eave event s t i me: uni x t i mest amp when t he event occur r ed count er : user count er change val ue user s - ar r ay of of al l user s t hat wer e i n t he sessi on user _i d: uni que user i d user _ni ck: ni ckname t hat user used i n t he sessi on user _i p_addr ess: I P f r om whi ch user j oi ned t he sessi on par t i ci pat i on: user ' s par t i ci pat i on dur at i on ( hh: mm: ss) par t i ci pat i on_i n_sec: par t i ci pat i on dur at i on i n seconds count r y: count r y f r om whi ch user connect ed t o t he sessi on; can be nul l i n case count r y coul d not be det ect ed ci t y: ci t y f r om whi ch t hi s user connect ed t o t he sessi on; can be nul l i n case count r y coul d not be det ect ed pl at f or m: user ' s pl at f or m on whi ch I SL Gr oop i s/ was r unni ng gr oop_ver si on: I SL Gr oop ver si on t hat user i s/ was r unni ng i n t he sessi on r egi st r ant s - ar r ay of user s t hat r egi st er ed f or t hi s sessi on user _r egi st r at i on_t i me: t i mest amp of user r egi st r at i on user _ni ck: r egi st r ant ' s ni ck name user _mai l : r egi st r ant ' s emai l addr ess sessi on - sessi on det ai l s sessi on_t ype: t ype of sessi on ( Webi nar, Meet i ng, et c) ; i f t hi s val ue i s empt y or nul l, sessi on t ype was meet i ng

27 ISL Online Web API Documentation Methods 27 sesson_t i t l e: sessi on' s t i t l e st at us_code: cur r ent sessi on' s st at us ( RUNNI NG, FI NI SHED, et c) sessi on_code: sessi on' s code sessi on_owner : f ul l user name of sessi on owner sessi on_owner _i d: uni que I D of t he owner st op_t i me: uni x t i mest amp of end of sessi on st ar t _t i me: uni x t i mest amp of st ar t of sessi on dur at i on: sessi on dur at i on t i me ( hh: mm: ss) dur at i on_i n_sec: sessi on dur at i on i n seconds par t i ci pant s: number of uni que par t i ci pant s i n al l sessi ons ppu: how much Pay Per Use cr edi t was used i n t hi s sessi on user s_r egi st er ed_count : number of user s t hat r egi st er ed t o j oi n t he sessi on ( i n case of webi nar ) ui d: : : e. com: : mai n t oken: secr et sessi on_i d: met hod=r epor t / gr oop/ sessi on/ det ai l s/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, sessi on_i d=12345 met hod=r epor t / gr oop/ sessi on/ det ai l s/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " sessi on_i d" : " 12345" } 3.15 report/groop/sessions/overview/get/1 Returns general information about ISL Groop usage for a given time period. met hod=r epor t / gr oop/ sessi ons/ over vi ew/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1

28 ISL Online Web API Documentation Methods 28 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d sessi ons_count : number of sessi ons st ar t ed sessi on_count _uni que: number of uni que sessi ons st ar t ed sessi ons_dur at i on: t ot al dur at i on of al l sessi ons ( hh: mm: ss) sessi on_dur at i on_i dl e: t ot al sessi ons i dl e t i me ( onl y one per son was i n t he sessi on) ppu: ammount Pay Per Use used by I SL Gr oop sessi ons ( hh: mm: ss) par t i ci pant s_count : number of user s i n al l sessi ons par t i ci pant s_count _uni que: number of uni que user s i n al l sessi ons l i censes_max: hi ghest number of l i censes used by a si ngl e sessi on sessi on_dur at i on_aver age: aver age l engt h of a sessi on par t i ci pant s_count _aver age: aver age number of par t i ci pant s i n t he sessi ons sessi ons_count _uni que_per cent : per cent age of uni que sessi ons par t i ci pant s_count _uni qi e_per cent : per cent age of uni que user s ui d: : : e. com: : mai n t oken: secr et f r om: t o: met hod=r epor t / gr oop/ sessi ons/ over vi ew/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= met hod=r epor t / gr oop/ sessi ons/ over vi ew/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " " }

29 ISL Online Web API Documentation Methods report/groop/sessions/overview/usage/get/1 Returns ISL Groop usage for each time unit in requested time period. met hod=r epor t / gr oop/ sessi ons/ over vi ew/ usage/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on u n i t [ s t r i n g ] ( r e q u i r e d ) onl y ' day' i s suppor t ed f or now J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d a n d t i me u n i t r ows - ar r ay of t i me uni t s uni t : uni x t i mest amp of st ar t of t he t i me uni t val ue: dur at i on of al l sessi ons i n t hi s t i me uni t ( hh: mm: ss) sessi on_count : number of sessi ons st ar t ed i n t hi s t i me uni t ui d: : : e. com: : mai n t oken: secr et f r om: t o: uni t : day

30 ISL Online Web API Documentation Methods 30 met hod=r epor t / gr oop/ sessi ons/ over vi ew/ usage/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= , uni t =day met hod=r epor t / gr oop/ sessi ons/ over vi ew/ usage/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " ", " uni t " : " day" } 3.17 report/license/usage/get/1 Returns hosted service license usage for each time unit in requested time period. met hod=r epor t / l i cense/ usage/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on u n i t [ s t r i n g ] ( r e q u i r e d ) onl y ' day' i s suppor t ed f or now J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d a n d t i me u n i t r ows - ar r ay of t i me uni t s uni t : uni x t i mest amp of st ar t of t he t i me uni t sessi on_l i ght : number of I SL Li ght sessi ons i n t hi s t i me uni t sessi on_gr oup: number of I SL Gr oop st ar t ed i n t hi s t i me uni t val ue: max. l i cense usage i n t hi s t i me uni t max_connect i ons: max. number of concur r ent connect i ons i n t hi s t i me uni t

31 ISL Online Web API Documentation Methods 31 ui d: : : e. com: : mai n t oken: secr et f r om: t o: uni t : day met hod=r epor t / l i cense/ usage/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= , uni t =day met hod=r epor t / l i cense/ usage/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " ", " uni t " : " day" } 3.18 report/light/sessions/overview/get/1 Returns general information about ISL Groop usage for a certain time period. met hod=r epor t / l i ght / sessi ons/ over vi ew/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on

32 ISL Online Web API Documentation Methods 32 J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d sessi ons_count : number of sessi ons st ar t ed sessi ons_dur at i on: t ot al dur at i on of al l sessi ons ( hh: mm: ss) sessi ons_dat a_t r ansf er ed: t ot al dat a t r af f i c i n al l sessi ons ppu: Pay Per Use used by I SL Li ght sessi ons ( hh: mm: ss) sessi ons_count _ppu: number of sessi ons t hat r equi r ed Pay Per Use sessi ons_dur at i on_mobi l e: t ot al dur at i on of al l sessi ons f r om mobi l e devi ces ( hh: mm: ss) sessi ons_count _by_pl at f or m - ar r ay of key- val ue pai r s: " pl at f or m" : " number _of _sessi ons" sessi ons_count _mobi l e: number of sessi ons st ar t ed f r om mobi l e devi ces sessi ons_count _mobi l e_per cent : per cent age of mobi l e st ar t ed sessi ons sessi ons_dur at i on_aver age: aver age l engt h of a sessi on sessi ons_dur at i on_mobi l e_aver age: aver age l engt h of a mobi l e st ar t ed sessi on sessi ons_count _ppu_per cent : per cent age of sessi ons t hat r equi r ed Pay Per Use ui d: : : e. com: : mai n t oken: secr et f r om: t o: met hod=r epor t / l i ght / sessi ons/ over vi ew/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= met hod=r epor t / l i ght / sessi ons/ over vi ew/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " " } 3.19 report/light/sessions/overview/usage/get/1 Returns ISL Light usage for each time unit in requested time period.

33 ISL Online Web API Documentation Methods 33 met hod=r epor t / l i ght / sessi ons/ over vi ew/ usage/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng i n vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on u n i t [ s t r i n g ] ( r e q u i r e d ) onl y ' day' i s suppor t ed f or now J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d a n d t i me u n i t r ows - ar r ay of uni t s uni t : uni x t i mest amp of st ar t of t he t i me uni t val ue: t ot al dur at i on of al l sessi ons ( hh: mm: ss) sessi on_count : number of sessi ons st ar t ed ui d: : : e. com: : mai n t oken: secr et f r om: t o: uni t : day met hod=r epor t / l i ght / sessi ons/ over vi ew/ usage/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= , uni t =day met hod=r epor t / l i ght / sessi ons/ over vi ew/ usage/ get / 1&he=JSON1

34 ISL Online Web API Documentation Methods 34 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " ", " uni t " : " day" } 3.20 report/ppu/status/get/1 Returns Pay Per Use usage for requested time period. met hod=r epor t / ppu/ st at us/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on u n i t [ s t r i n g ] ( r e q u i r e d ) onl y ' day' i s suppor t ed f or now J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d a n d t i me u n i t r ows - ar r ay of uni t s uni t : uni x t i mest amp of st ar t of t he t i me uni t val ue: Pay Per Use usage ( hh: mm: ss) ui d: : : e. com: : mai n t oken: secr et f r om:

35 ISL Online Web API Documentation Methods 35 t o: uni t : day met hod=r epor t / ppu/ st at us/ get / 1&he=JSON1 : ui d=: : e. com: : mai n, t oken=secr et, f r om= , t o= , uni t =day met hod=r epor t / ppu/ st at us/ get / 1&he=JSON1 : j son={ " ui d" : " : : e. com: : mai n", " t oken" : " secr et ", " f r om" : " ", " t o" : " ", " uni t " : " day" } 3.21 report/pronto/chat/overview/get/1 Returns the basic overview of ISL Pronto chats in the requested time period and overview data for each unit. met hod=r epor t / pr ont o/ chat / over vi ew/ get / 1 t o k e n [ s t r i n g ] ( r e q u i r e d ) aut hent i cat i on t oken can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod u i d [ s t r i n g ] ( r e q u i r e d ) user i d can be acqui r ed by l oggi ng vi a API sso/ l ogi n/ 1 met hod f r o m [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he st ar t of t he per i od i n quest i on t o [ i n t e g e r ] ( r e q u i r e d ) uni x t i mest amp of t he end of t he per i od i n quest i on u n i t [ s t r i n g ] ( r e q u i r e d ) onl y ' day' i s suppor t ed f or now J SON d a t a o b j e c t - Al l f i e l d s d e p e n d o n t i me p e r i o d a n d t i me u n i t r ows - ar r ay of uni t s O2O: st at i st i cs f or Oper at or t o Oper at or chat s uni t : uni x t i mest amp of st ar t of t he t i me uni t dur at i on: t ot al dur at i on of chat s i n t he t i me uni t wai t _t i me: t ot al wai t t i me f or chat s i n t hi s t i me uni t