ISL Online Web API Documentation
ISL Online Web API Documentation
Contents
2
Table of Contents
Foreword
Part I Overview
Part II Communication model
Part III Methods
0
4
5
8
...............................................................................................................................................................................
1 account/passw ord/change/1
8
...............................................................................................................................................................................
2 account/hosted/domain/set/1
9
...............................................................................................................................................................................
3 account/passw ord/forgot/1
10
...............................................................................................................................................................................
4 account/signup/1
11
...............................................................................................................................................................................
5 account/signup/tw ostep/1
12
...............................................................................................................................................................................
6 content/brochure/languages/get/1
15
...............................................................................................................................................................................
7 content/brochure/get/1
16
...............................................................................................................................................................................
8 content/resellers/get/1
16
...............................................................................................................................................................................
9 content/shop/items/get/1
18
...............................................................................................................................................................................
10 localization/translation/resources/get/1
19
...............................................................................................................................................................................
11 localization/translation/single/get/1
21
...............................................................................................................................................................................
12 localization/translation/single/insert/1
23
...............................................................................................................................................................................
13 report/accounthistory/status/get/1
24
...............................................................................................................................................................................
14 report/groop/session/details/get/1
26
...............................................................................................................................................................................
15 report/groop/sessions/overview /get/1
27
...............................................................................................................................................................................
16 report/groop/sessions/overview /usage/get/1
29
...............................................................................................................................................................................
17 report/license/usage/get/1
30
...............................................................................................................................................................................
18 report/light/sessions/overview /get/1
31
...............................................................................................................................................................................
19 report/light/sessions/overview /usage/get/1
32
...............................................................................................................................................................................
20 report/ppu/status/get/1
34
...............................................................................................................................................................................
21 report/pronto/chat/overview /get/1
35
...............................................................................................................................................................................
22 report/pronto/supporters/overview /get/1
37
...............................................................................................................................................................................
23 report/pronto/overview /hours/get/1
38
...............................................................................................................................................................................
24 report/pronto/overview /filters/get/1
39
...............................................................................................................................................................................
25 report/pronto/messages/offline/get/1
41
...............................................................................................................................................................................
26 sso/login/1
42
...............................................................................................................................................................................
27 sso/login/get/1
43
Part IV jQuery plugin v1.0
45
© 2016 ISL Online
2
ISL Online Web API Documentation
Index
Contents
3
0
© 2016 ISL Online
3
ISL Online Web API Documentation
1
Overview
4
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.
© 2016 ISL Online
ISL Online Web API Documentation
2
Communication model
5
Communication model
User API communicates via HTTP protocol and provides 3 ways of communication
(POST/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
POST over GET method for sending data (except in the case of JSONP). All data sent
via POST 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 639-1 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-3166-1 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:
© 2016 ISL Online
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 s on={
" met hod" : " met hod_name" ,
" r es pons e" : {
" r es ul t " : {
" des c r i pt i on" : " gener at ed des c r i pt i on" ,
" des c r i pt i on_or i g" : " gener at ed non- t r ans l at ed des c r i pt i on" ,
" c ode" : " r es ul t _c ode" ,
" ar gs " : " ar gument _k ey " OR [ " ar r ay " , " of " , " ar gument s " ]
},
" dat a" : " v al ue" OR [ " ar r ay " , " of " , " v al ues " ] OR { " r et ur ned" :
" v al ue" }
}
}
XML1 structure:
<?x ml v er s i on=" 1. 0" enc odi ng=" ut f - 8" ?>
<api >
<met hod>met hod_name</ met hod>
<r es pons e>
<r es ul t >
<des c r i pt i on>gener at ed des c r i pt i on</ des c r i pt i on>
<c ode>r es ul t _c ode</ c ode>
<ar gs >ar r ay </ ar gs >
<ar gs >of </ ar gs >
<ar gs >ar gument s </ ar gs >
</ r es ul t >
<dat a>r et ur ned v al ue</ dat a>
<dat a>r et ur ned v al ue</ dat a>
</ r es pons e>
</ api >
API Messages
A part of response object is result code, which holds one of the predefined values:
© 2016 ISL Online
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
© 2016 ISL Online
ISL Online Web API Documentation
3
Methods
8
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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i ne- ac c ount . php?
met hod=ac c ount / pas s wor d/ c hange/ 1
Parameters
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 )
ui d [ s t r i ng] ( r equi r ed)
p a s s wo r d [ s t r i n g ] ( r e q u i r e d )
r andom [ s t r i ng] ( r equi r ed)
Return Values
None
Example
PARAMETERS
r es pons e enc odi ng: J SON
emai l _addr es s : us er @ex ampl e. c om
ui d: domai n: : us er @ex ampl e. c om: : mai n
pas s wor d: s ec r et
r andom: 12345678
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / pas s wor d/ c hange/ 1&he=J SON1
POST:
emai l _addr es s =us er @ex ampl e. c om&ui d=domai n: : us er @ex ampl e. c om: : mai n&pas s wor d=
© 2016 ISL Online
ISL Online Web API Documentation
Methods
9
s ec r et &r andom=12345678
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / pas s wor d/ c hange/ 1&he=J SON1
POST:
j s on={
" emai l _addr es s "
:
" us er @ex ampl e. c om" ,
" ui d"
:
" domai n: : us er @ex ampl e. c om: : mai n" ,
" pas s wor d"
:
" s ec r et " ,
" r andom"
:
" 12345678" }
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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i ne- ac c ount . php?
met hod=ac c ount / hos t ed/ domai n/ s et / 1
Parameters
d o ma i n _ n a me [ s t
ui d [ s t r i ng] ( r
t ok en [ s t r i ng]
aut hent i c at i
met hod
r i ng] ( r equi r ed)
equi r ed)
( r equi r ed)
on t ok en c an be ac qui r ed by l oggi ng i n v i a API
s s o/ l ogi n/ 1
Return Values
None
Example
PARAMETERS
r es pons e enc odi ng: J SON
domai n_name: my domai n
ui d: domai n: : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / hos t ed/ domai n/ s et / 1&he=J SON1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
10
POST:
domai n_name=my domai n&ui d=domai n: : us er @ex ampl e. c om: : mai n&t ok en=s ec r et
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / pas s wor d/ c hange/ 1&he=J SON1
POST:
j s on={
" domai n_name"
:
" my domai n" ,
" ui d"
:
" domai n: : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " }
3.3
account/password/forgot/1
Sends email with account details to user registered with provided email address.
Description
The call will generate an email with link to reset password and send it to the
emai l _addr es s .
Exception:
When setting hl=ja (japanese language) it will work as old password forgot and resend
old email with authentication details.
Now it works like this – it will send username and password for:
- If email address match www account email address (from registration)
- If email address of additional user matches
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i ne- ac c ount . php?
met hod=ac c ount / pas s wor d/ f or got / 1
Parameters
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 )
© 2016 ISL Online
ISL Online Web API Documentation
Methods
11
Return Values
None
Example
PARAMETERS
r es pons e enc odi ng: J SON
emai l _addr es s : us er @ex ampl e. c om
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / pas s wor d/ f or got / 1&he=J SON1
POST: emai l _addr es s =us er @ex ampl e. c om
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / pas s wor d/ f or got / 1&he=J SON1
POST: j s on={ " emai l _addr es s " : " us er @ex ampl e. c om" }
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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i ne- ac c ount . php?
met hod=ac c ount / s i gnup/ 1
Parameters
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 )
or i gi n [ obj ec t ]
i nf or mat i on about t he us er
r es el l er I d [ i nt eger ]
i f no v al ue i s s et , HQ r es el l er i d i s s et
ar i d [ i nt eger ]
l ook at r es el l er I d
© 2016 ISL Online
ISL Online Web API Documentation
Methods
12
Return Values
None
Example
PARAMETERS
r es pons e enc odi ng: J SON
us er _name: us er @ex ampl e. c om
pas s wor d: s ec r et
ar i d: 333133
or i gi n:
{ " appCodeName" : " Moz i l l a" ,
" appMi nor Ver s i on" :
" undef i ned" , " appName" : " Net s c ape" , " appVer s i on" : " 5. 0
( Wi ndows ) " , " c ook i eEnabl ed" : " t r ue" , " c puCl as s " : " undef i ned" , " onLi ne" : " t r ue" , " p
l at f or m" : " Wi n32" , " s y s t emLanguage" : " undef i ned" , " us er Agent " : " Moz i l l a/ 5. 0
( Wi ndows
NT
6. 1;
WOW64;
r v : 10. 0. 2)
Gec k o/ 20100101
Fi r ef ox / 10. 0. 2" , " us er Language" : " undef i ned" }
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ 1&he=J SON1
us er _name=us er @ex ampl e. c om, pas s wor d=s ec r et , r es el l er I d=333133, or i gi n=
" { \ " appCodeName\ " : \ " Moz i l l a\ " , \ " appMi nor Ver s i on\ " : \ " undef i ned\ " , \ " appName
\ " : \ " Net s c ape\ " , \ " appVer s i on\ " : \ " 5. 0
( Wi ndows ) \ " , \ " c ook i eEnabl ed\ " : \ " t r ue
\ " , \ " c puCl as s \ " : \ " undef i ned\ " , \ " onLi ne\ " : \ " t r ue\ " , \ " pl at f or m\ " : \ " Wi n32\ " ,
\ " s y s t emLanguage\ " : \ " undef i ned\ " , \ " us er Agent \ " : \ " Moz i l l a/ 5. 0
( Wi ndows
NT
6. 1; WOW64; r v : 10. 0. 2) Gec k o/ 20100101 Fi r ef ox / 10. 0. 2\ " , \ " us er Language\ " :
\ " undef i ned\ " } "
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ 1&he=J SON1
POST: j s on={ " us er _name" : " us er @ex ampl e. c om" , " pas s wor d" : " s ec r et " ,
" ar i d"
:
" 333133" ,
" or i gi n"
:
" { \ " appCodeName\ " : \ " Moz i l l a\ " ,
\ " appMi nor Ver s i on\ " : \ " undef i ned\ " , \ " appName\ " : \ " Net s c ape\ " , \ " appVer s i on\ " :
\ " 5. 0
( Wi ndows ) \ " , \ " c ook i eEnabl ed\ " : \ " t r ue\ " , \ " c puCl as s \ " : \ " undef i ned\ " ,
\ " onLi ne\ " : \ " t r ue\ " , \ " pl at f or m\ " : \ " Wi n32\ " , \ " s y s t emLanguage\ " : \ " undef i ned
\ " , \ " us er Agent \ " : \ " Moz i l l a/ 5. 0
( Wi ndows
NT
6. 1;
WOW64;
r v : 10. 0. 2)
Gec k o/ 20100101 Fi r ef ox / 10. 0. 2\ " , \ " us er 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.
© 2016 ISL Online
ISL Online Web API Documentation
Methods
13
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i ne- ac c ount . php?
met hod=ac c ount / s i gnup/ t wos t ep/ 1
Parameters
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 ep [ i nt eger ] ( r equi r ed)
s houl d hav e v al ue 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 ep [ i nt eger ] ( r equi r ed)
s houl d hav e v al ue 2
p a s s wo r d [ s t r i n g ] ( r e q u i r e d )
r andom [ s t r i ng] ( r equi r ed)
c ount r y _c ode [ s t r i ng] ( r equi r ed)
or i gi n [ obj ec t ] ( r equi r ed)
ar i d [ i nt eger ] ( r equi r ed)
c o mp a n y
f u l l _ n a me
p h o n e _ n u mb e r
Return Values
None
Example
St e p 1 :
PARAMETERS
r es pons e enc odi ng: J SON
emai l _addr es s : us er @ex ampl e. c om
s t ep: 1
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1
POST: us er _name=us er @ex ampl e. c om, s t ep=1
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1
POST: j s on={ " us er _name" : " us er @ex ampl e. c om" , " s t ep" : " 1" }
St e p 2 :
PARAMETERS
© 2016 ISL Online
ISL Online Web API Documentation
Methods
14
r es pons e enc odi ng: J SON
us er _name: us er @ex ampl e. c om
pas s wor d: s ec r et
s t ep: 2
r andom: 12345678
c ount r y _c ode: ES
or i gi n: { " appCodeName" : " Moz i l l a" , " appMi nor Ver s i on" :
" undef i ned" , " appName" : " Net s c ape" , " appVer s i on" : " 5. 0
( Wi ndows ) " , " c ook i eEnabl ed" : " t r ue" , " c puCl as s " : " undef i ned" , " onLi ne" : " t r ue" , " p
l at f or m" : " Wi n32" , " s y s t emLanguage" : " undef i ned" , " us er Agent " : " Moz i l l a/ 5. 0
( Wi ndows NT 6. 1; WOW64; r v : 10. 0. 2) Gec k o/ 20100101
Fi r ef ox / 10. 0. 2" , " us er Language" : " undef i ned" }
ar i d: 333133
c ompany : My Company
f ul l _name: Ful l Name
phone_number : +1 23 456- 7890
GET
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1&us er _name=us er %
40ex ampl e. c om&pas s wor d=s ec r et &s t ep=2&r andom=12345678&c ount r y _c ode=ES&c ompan
y =My %20Company &f ul l _name=Ful l %20Name&phone_number =%2B1%2023%204567890&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 %
3A10. 0. 2) %20Gec k o%2F20100101%20Fi r ef ox %2F10. 0. 2%22%2C%22us er Language%22%3A%
22undef i ned%22%7D
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1
POST: us er _name=us er @ex ampl e. c om, pas s wor d=s ec r et , s t ep=2,
r andom=12345678, c ount r y _c ode=ES, or i gi n={ \ " appCodeName\ " : \ " Moz i l l a\ " ,
\ " appMi nor Ver s i on\ " : \ " undef i ned\ " , \ " appName\ " : \ " Net s c ape\ " , \ " appVer s i on\ " :
\ " 5. 0 ( Wi ndows ) \ " , \ " c ook i eEnabl ed\ " : \ " t r ue\ " , \ " c puCl as s \ " : \ " undef i ned\ " ,
\ " onLi ne\ " : \ " t r ue\ " , \ " pl at f or m\ " : \ " Wi n32\ " , \ " s y s t emLanguage\ " : \ " undef i ned
\ " , \ " us er Agent \ " : \ " Moz i l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64; r v : 10. 0. 2)
Gec k o/ 20100101 Fi r ef ox / 10. 0. 2\ " , \ " us er Language\ " : \ " undef i ned\ " } ,
ar i d=333133, c ompany =My Company , f ul l _name=Ful l Name, phone_number =+1 23
456- 7890
J SON GET
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1&j s on%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%
2212345678%22%2C%20%22c ount r y _c ode%22%20%3A%20%22ES%22%2C%20%22ar i d%22%20%
3A%20%22333133%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%20456- 7890%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%
206. 1%3B%20WOW64%3B%20r v %3A10. 0. 2) %20Gec k o%2F20100101%20Fi r ef ox %2F10. 0. 2%
22%2C%22us er Language%22%3A%22undef i ned%22%7D
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- ac c ount / 1- 0/ i s l onl i neac c ount . php?met hod=ac c ount / s i gnup/ t wos t ep/ 1&he=J SON1
POST: j s on={ " us er _name" : " us er @ex ampl e. c om" , " pas s wor d" : " s ec r et " ,
" s t ep" : " 2" , " r andom" : " 12345678" , " c ount r y _c ode" : " ES" , " ar i d" :
" 333133" , " c ompany " : " My Company " , " f ul l _name" : " Ful l Name" ,
" phone_number " : " +1 23 456- 7890" , " or i gi n" : " { \ " appCodeName\ " : \ " Moz i l l a
\ " , \ " appMi nor Ver s i on\ " : \ " undef i ned\ " , \ " appName\ " : \ " Net s c ape\ " ,
© 2016 ISL Online
ISL Online Web API Documentation
Methods
15
\ " appVer s i on\ " : \ " 5. 0 ( Wi ndows ) \ " , \ " c ook i eEnabl ed\ " : \ " t r ue\ " , \ " c puCl as s \ " :
\ " undef i ned\ " , \ " onLi ne\ " : \ " t r ue\ " , \ " pl at f or m\ " : \ " Wi n32\ " , \ " s y s t emLanguage
\ " : \ " undef i ned\ " , \ " us er Agent \ " : \ " Moz i l l a/ 5. 0 ( Wi ndows NT 6. 1; WOW64;
r v : 10. 0. 2) Gec k o/ 20100101 Fi r ef ox / 10. 0. 2\ " , \ " us er Language\ " : \ " undef i ned\ " } "
}
3.6
content/brochure/languages/get/1
Returns available brochure languages and their website paths.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i ne- c ont ent . php?
met hod=c ont ent / br oc hur e/ l anguages / get / 1
Parameters
y ear [ i nt eger ]
Return Values
J SON d a t a o b j e c t
l anguages - k ey - v al ue par ,
t o br oc hur e
wher e k ey i s l anguage c ode and v al ue i s pat h
Example
PARAMETERS
r es pons e enc odi ng: J SON
y ear : 2012
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i nec ont ent . php?met hod=c ont ent / br oc hur e/ l anguages / get / 1&he=J SON1
POST: y ear =2012
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=c ont ent / br oc hur e/ l anguages / get / 1&he=J SON1
POST: j s on={ " y ear " : " 2012" }
© 2016 ISL Online
ISL Online Web API Documentation
3.7
Methods
16
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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i ne- c ont ent . php?
met hod=c ont ent / br oc hur e/ get / 1
Parameters
y ear [ i nt eger ] ( r equi r ed)
l anguage [ s t r i ng] ( r equi r ed)
t y pe [ s t r i ng]
i f i t i s s et t o pr emi um, a pr emi um br oc hur e wi l l
be r et ur ned
Return Values
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
Example
PARAMETERS
r es pons e enc odi ng: J SON
y ear : 2012
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i nec ont ent . php?met hod=c ont ent / br oc hur e/ get / 1&he=J SON1
POST: y ear =2012&l anguage=en
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=c ont ent / br oc hur e/ get / 1&he=J SON1
POST: j s on={ " y ear " : " 2012" , " l anguage" : " en" }
3.8
content/resellers/get/1
Returns available brochure languages and their website paths.
© 2016 ISL Online
ISL Online Web API Documentation
Methods
17
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i ne- c ont ent . php?
met hod=c ont ent / r es el l er s / get / 1
Parameters
One of t he ar gument
ar i d [ i nt eger ]
r et ur ns onl y
c ount r y _c ode [ s t
r et ur ns l i s t
s i s r equi r ed
dat a of r es el l er wi t h pas s ed RI D
r i ng]
of r es el l er s f or s pec i f i c c ount r y
Return Values
J SON d a t a o b j e c t
r es el l er s
s or t ed_name - obj ec t wi t h r es el l er ' s i nf o
ar i d - r es el l er ' s I D
l abel - r es el l er ' s name
c ont ac t _det ai l s - obj ec t wi t h r es el l er ' s c ont ac t det ai l s
av ai 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 es el l er s ) :
appoi nt ment - appoi nt ed c ount r y
name - f ul l r es el l er ' s name
hr ef - r es el l er ' s web s i t e
f ul l _addr es s - r es el l er ' s addr es s
emai l - r es el l er ' s c ont ac t emai l addr es s
t el ephone - r es el l er ' s phone number
t el ef ax - r es el l er ' s t el ef ax number
v at _i d - r es el l er ' s VAT number
s el ec t ed - i f r es el l er s houl d be pr es el l ec t ed
Example
PARAMETERS
r es pons e enc odi ng: J SON
c ount r y _c ode: US
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i nec ont ent . php?met hod=c ont ent / r es el l er s / get / 1&he=J SON1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
18
POST: c ount r y _c ode=US
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=c ont ent / r es el l er s / get / 1&he=J SON1
POST: j s on={ " c ount r y _c ode" : " 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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i ne- c ont ent . php?
met hod=c ont ent / s hop/ i t ems / get / 1
Parameters
c ount r y _c ode [ s t r i ng] ( r equi r ed)
c ount r y c ode s houl d be i n t he f or m of upper c as ed t wo l et t er c ode ( I SO
3166- 1
al pha- 2) .
The
r es ul t
wi l l
be
c ount r y
s pec i f i c
( c ur r enc y ,
pr i c es , . . . )
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 c es wi t hout dec i mal pl ac es i s r equi r ed t hi s s houl d be s et t o t r ue.
Def aul t v al ue i s f al s e
Return Values
J SON d a t a o b j e c t
c ur r enc y _s y mbol - c ount r y ' s c ur r enc y c ode
c ur r enc y _s y mbol _i n_f r ont - i f i s s et t o t r ue, t he c ur r enc y c ode i s
wr i t t en bef or e t he pr i c e
c ur r enc y _dec i mal - c har ac t er us ed t o s eper at e dec i mal pl ac es
c ur r enc y _di gi t _gr oupi ng_s y mbol - c har ac t er us ed t o t hous ands , mi l l i ons
et c .
c ur r enc y _di gi t s _af t er _dec i mal - how many dec i mal pl ac es pr i c e s houl d
hav e
i t ems
i t em_c ode - s hop i t em c ode
det ai l ed_des c r i pt i on - i t em' s l ong des c r i pt i on
s hor t _des c r i pt i on - i t em' s s hor t des c r i pt i on
f i l t er - t o whi c h gr oup i t em bel ongs
s k u - i t em' s SKU c ode
pr i c e_numer i c - pr i c e i n t he f or m of number
© 2016 ISL Online
ISL Online Web API Documentation
Methods
19
pr i c e_di s pl ay - pr i c e f or mat ed f or di s pl ay
quant i t y _par ams - det ai l s about quant i t y , dur at i on, di s c ount s et c .
Example
PARAMETERS
r es pons e enc odi ng: J SON
c ount r y _c ode: US
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- c ont ent / 1- 0/ i s l onl i nec ont ent . php?met hod=c ont ent / s hop/ i t ems / get / 1&he=J SON1
POST: c ount r y _c ode=US
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=c ont ent / s hop/ i t ems / get / 1&he=J SON1
POST: j s on={ " c ount r y _c ode" : " US" }
3.10
localization/translation/resources/get/1
Returns list of all resources and their translation/localization status.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ r es our c es / get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
par t ner _c ode [ s t r i ng] ( r equi r ed)
par t ner c ode pr ov i ded t o y ou by I SL Onl i ne
l anguage_c ode [ s t r i ng] ( r equi r ed)
I SO 639- 1 l anguage c ode; t hi s def i nes l oc al i z at i on l anguage
of f s et [ i nt eger ]
of f s et 100 means t hat r es ul t s wi l l be s hown f r om 100t h r es ul t on
l i mi t [ i n t e g e r ]
how many r es ul t s ar e s hown i n r es pons e; max i mum number i s 100
s or t [ k ey - v al ue pai r ar r ay ]
def i nes how r es ul t s s houl d be s or t ed;
f i r s t v al ue s houl d be f i el d name, s ec ond s houl d be s or t di r ec t i on;
© 2016 ISL Online
ISL Online Web API Documentation
Methods
20
i f mul t i pl e s or t f i el ds ar e pas s ed, t hey wi l l be par s ed i n or der i n
whi c h t hey r es i de i n ar r ay ( FI FO)
Suppor t ed f i el ds :
r es our c e_i d
pr ogr am_name
c ont ex t
t r ans l at abl e_s t r i ngs
unt r ans l at ed_s t r i ngs
wor d_c ount
Suppor t ed di r ec t i ons :
ASC - f or as c endi ng
DESC - f or des c endi ng
f i l t er [ k ey - v al ue pai r ar r ay ]
def i nes how r es ul t s s houl d be f i l t er ed;
f i r s t v al ue s houl d be f i el d name, s ec ond s houl d be f i el d v al ue;
i f mul t i pl e f i el ds ar e pas s ed AND l ogi c al oper at or wi l l be put bet ween
t hem
Suppor t ed f i el ds :
modul e_name [ s t r i ng] - ex ec ut es c as e i ns ens i t i v e l ef t and r i ght
s ear c h ( SL wi l l mat c h al s o I SL Onl i ne)
pr ogr am_name [ s t r i ng] - ex ec ut es c as e i ns ens i t i v e l ef t and r i ght
s ear c h ( SL wi l l mat c h al s o I SL Onl i ne)
c ont ex t [ s t r i ng] - ex ec ut es c as e i ns ens i t i v e l ef t and r i ght s ear c h
( SL wi l l mat c h al s o I SL Onl i ne)
pl ugi n_name [ s t r i ng] - ex ec ut es c as e i ns ens i t i v e l ef t and r i ght
s ear c h ( SL wi l l mat c h al s o I SL Onl i ne)
t r ans l at i on_v er s i on [ s t r i ng] - ex ec ut es ex ac t s ear c h ( 1. 1 wi l l not
mat c h 1. 1. 3, but onl y 1. 1, al s o 1. 1A wi l l not mat c h 1. 1a)
t r ans l at ed [ bool ean] - i f t r ans l at ed i s s et t o t r ue onl y r es our c es
f ul l y t r ans l at ed wi l l be s hown
Return Values
J SON d a t a o b j e c t
r es our c es - ar r ay of r es our c es av ai l abl e f or t r ans l at i on
r es our c e_i d: i d of r es our c e
modul e_name: t o whi c h modul e t r ans l at i on r ef er s
pr ogr am_name: t o whi c h pr ogr am t r ans l at i on r ef er s
c ont ex t : t o whi c h c ont ex t t r ans l at i on i s r el at ed
pl ugi n_name: t o whi c h pl ugi n t r ans l at i on r ef er s
t r ans l at i on_v er s i on: t r ans l at i on v er s i on
t r ans l at abl e_s t r i ngs : number of s t r i ngs t hat c an be t r ans l at ed
unt r ans l at ed_s t r i ngs : number of unt r ans l at ed s t r i ngs
wor d_c ount : number of wor ds t hat c an be t r ans l at ed
© 2016 ISL Online
ISL Online Web API Documentation
Methods
21
Example
EXAMPLE 1
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
par t ner _c ode: par t ner - c ode
l anguage_c ode: es
of f s et : 6
l i mi t : 3
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ r es our c es / get / 1&he=J SON1
POST: ui d=: : us er @ex ampl e. c om: : mai n, t ok en=s ec r et , par t ner _c ode=par t ner c ode, l anguage_c ode=es , of f s et =6, l i mi t =3
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ r es our c es / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" par t ner _c ode" : " par t ner - c ode" , " l anguage_c ode" : " es " , " of f s et " : " 6" ,
" l i mi t " : " 3" }
EXAMPLE 2: When us i ng s or t or f i l t er par amet er s , J SON GET or J SON POST
met hod mus t be us ed!
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
par t ner _c ode: par t ner - c ode
l anguage_c ode: es
of f s et : 6
l i mi t : 3
s or t : r es our c e_i d=ASC
f i l t er : pr ogr am_name=l i ght , t r ans l at ed=f al s e, t r ans l at i on_v er s i on=1
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ r es our c es / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" par t ner _c ode" : " par t ner - c ode" , " l anguage_c ode" : " es " , " of f s et " : " 6" ,
" l i mi t " : " 3" , " s or t " : { " r es our c e_i d" : " ASC" } , " f i l t er " :
{ " pr ogr am_name" : " l i ght " , " t r ans l at ed" : " f al s e" , " t r ans l at i on_v er s i on" :
" 1" } }
3.11
localization/translation/single/get/1
Returns list of all strings available for translation in a single resource.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ get / 1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
22
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
par t ner _c ode [ s t r i ng] ( r equi r ed)
par t ner c ode pr ov i ded t o y ou by I SL Onl i ne
l anguage_c ode [ s t r i ng] ( r equi r ed)
I SO 639- 1 l anguage c ode; t hi s def i nes l oc al i z at i on l anguage
r es our c e_i d [ i nt eger ]
r es our c e i d, whi c h c an be obt ai ned by c al l i ng l oc al i z at i on/ t r ans l at i on/
r es our c es / get / 1 met hod
Return Values
J SON d a t a o b j e c t
t r ans l at i ons - ar r ay of t r ans l at i on s t r i ngs
r es our c e_i d: i d of r es our c e
l anguage_c ode: t o whi c h l anguage t r ans l at i ons r ef er
t r ans l at i ons : ar r ay of t r ans l at i ons s t r i ngs
or i gi nal _t ex t : t ex t ex pos ed f or t r ans l at i on
t r ans l at ed_t ex t : c ur r ent t r ans l at i on of or i gi nal t ex t
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
par t ner _c ode: par t ner - c ode
l anguage_c ode: es
r es our c e_i d: 108
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ get / 1&he=J SON1
POST: ui d=: : us er @ex ampl e. c om: : mai n, t ok en=s ec r et , par t ner _c ode=par t ner c ode, l anguage_c ode=es , r es our c e_i d=108
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ get / 1&he=J SON1
© 2016 ISL Online
ISL Online Web API Documentation
POST: j s on={
" par t ner _c ode" :
" 108" }
3.12
Methods
23
" ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" par t ner - c ode" , " l anguage_c ode" : " es " , " r es our c e_i d" :
localization/translation/single/insert/1
Inserts new translation for given translation string in single resource.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ i ns er t / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
par t ner _c ode [ s t r i ng] ( r equi r ed)
par t ner c ode pr ov i ded t o y ou by I SL Onl i ne
l anguage_c ode [ s t r i ng] ( r equi r ed)
I SO 639- 1 l anguage c ode; t hi s def i nes l oc al i z at i on l anguage
r es our c e_i d [ i nt eger ]
r es our c e i d, whi c h c an be obt ai ned by c al l i ng l oc al i z at i on/ t r ans l at i
r es our c es / get / 1 met hod
or i gi nal _t ex t [ s t r i ng]
or i gi nal
t ex t ,
whi c h c an be obt ai ned by c al l i ng l oc al i z at i
t r ans l at i on/ s i ngl e/ get / 1 met hod
t r ans l at ed_t ex t [ s t r i ng]
new t r ans l at i on t ex t ;
c ur r ent t r ans l at i on t ex t c an be obt ai ned by c al l i ng l oc al i z at i
t r ans l at i on/ s i ngl e/ get / 1 met hod
n/ 1
on/
on/
on/
Return Values
J SON d a t a o b j e c t
t r ans l at i on - i nf or mat i on about what was updat ed
r es our c e_i d: i d of r es our c e
l anguage_c ode: t o whi c h l anguage t r ans l at i ons r ef er
or i gi nal _t ex t : t ex t t hat was t r ans l at ed
t r ans l at ed_t ex t : new t r ans l at i on t ex t
© 2016 ISL Online
ISL Online Web API Documentation
Methods
24
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
par t ner _c ode: par t ner - c ode
l anguage_c ode: es
r es our c e_i d: 108
or i gi nal _t ex t : Admi n mode
t r ans l at ed_t ex t : Admi ni s t r at i v e mode
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ i ns er t / 1&he=J SON1
POST: ui d=: : us er @ex ampl e. c om: : mai n, t ok en=s ec r et , par t ner _c ode=par t ner c ode,
l anguage_c ode=es ,
r es our c e_i d=108,
or i gi nal _t ex t =Admi n
mode,
t r ans l at ed_t ex t =Admi ni s t r at i v e mode
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- l oc al i z at i on/ 1- 0/ i s l onl i nel oc al i z at i on. php?met hod=l oc al i z at i on/ t r ans l at i on/ s i ngl e/ i ns er t / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" par t ner _c ode" : " par t ner - c ode" , " l anguage_c ode" : " es " , " r es our c e_i d" :
" 108" , " or i gi nal _t ex t " : " Admi n mode" , " t r ans l at ed_t ex t " : " Admi ni s t r at i v e
mode" }
3.13
report/accounthistory/status/get/1
Returns account's subscription status.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ac c ount hi s t or y / s t at us / get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
© 2016 ISL Online
ISL Online Web API Documentation
Methods
25
Return Values
J SON d a t a o b j e c t
l hs _t y pe_c ode: c ode of s ubs c r i pt i on t y pe
l hs _t y pe_des c r i pt i on: s ubs c r i pt i on t y pe
s ub: s ubs c r i pt i on ( t =t r ue/ y es , f =f al s e/ no)
s ub_ac t i v e: i s s ubs c r i pt i on s t i l l ac t i v e ( t =t r ue/ y es , f =f al s e/ no)
s ub_s t ar t : s ubs c r i pt i on s t ar t dat et i me
s ub_s t ar t _l oc al : s ubs c r i pt i on s t ar t dat et i me i n l oc al t i me
s ub_ex pi r e: s ubs c r i pt i on ex pi r y dat et i me
s ub_ex pi r e_l oc al : s ubs c r i pt i on ex pi r y dat et i me i n l oc al t i me
s ub_s es s i on_max _c onc ur r ent : number of l i c ens es i n s ubs c r i pt i on
s ub_s es s i on_max _c l i ent s : max . number of c l i ent s al l owed
s ub_mul t i _s es s i on_l i c ens e: does s ubs c r i pt i on i nc l ude mul t i
s es s i on
l i c ens e ( t =t r ue/ y es , f =f al s e/ no)
s ub_pr emi um_s uppor t : does s ubs c r i pt i on i nc l ude pr emi um s uppor t ( t =t r ue/
y es , f =f al s e/ no)
s ub_pl ugi n_v i deo: does s ubs c r i pt i on i nc l ude v i deo pl ugi n ( t =t r ue/ y es ,
f =f al s e/ no)
s ub_pl ugi n_audi o: does s ubs c r i pt i on i nc l ude audi o pl ugi n ( t =t r ue/ y es ,
f =f al s e/ no)
ppu: does t hi s ac c ount i nc l ude Pay Per Us e ( t =t r ue/ y es , f =f al s e/ no)
ppu_ac t i v e: i s Pay Per Us e s t i l l ac t i v e - c an t he c r edi t s be us ed
( t =t r ue/ y es , f =f al s e/ no)
ppu_ex pi r e: Pay Per Us e s ubs c r i pt i on ex pi r y dat et i me
ppu_ex pi r e_l oc al : Pay Per Us e s ubs c r i pt i on ex pi r y dat et i me i n l oc al t i me
ppu_c r edi t s : how many Pay Per Us e t i me i s l ef t on s ubs c r i pt i on
( hh: mm: s s ) ; i n c as e t her e i s no PPU t i me, t hi s v al ue mi ght s how - 00: 00: 01
ppu_c r edi t s _mi nut es : how many Pay Per Us e t i me i n mi nut es i s s t i l l
av ai l abl e on s ubs c r i pt i on; i n c as e t her e i s no PPU t i me, t hi s v al ue mi ght
s how - 0. 0166666666666667
c ur r enc y _c ode: s ubs c r i ber ' s c ur r enc y c ode
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ac c ount hi s t or y / s t at us / get / 1&he=J SON1
POST: ui d=: : us er @ex ampl e. c om: : mai n, t ok en=s ec r et
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ac c ount hi s t or y / s t at us / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " }
© 2016 ISL Online
ISL Online Web API Documentation
3.14
Methods
26
report/groop/session/details/get/1
Returns all details about a single ISL Groop session.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i on/ det ai l s / get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
s es s i on_i d [ s t r i ng] ( r equi r ed)
Return Values
J SON d a t a o b j e c t
ev ent s - ar r ay of us er j oi n/ l eav e ev ent s
t i me: uni x t i mes t amp when t he ev ent oc c ur r ed
c ount er : us er c ount er c hange v al ue
us er s - ar r ay of of al l us er s t hat wer e i n t he s es s i on
us er _i d: uni que us er i d
us er _ni c k : ni c k name t hat us er us ed i n t he s es s i on
us er _i p_addr es s : I P f r om whi c h us er j oi ned t he s es s i on
par t i c i pat i on: us er ' s par t i c i pat i on dur at i on ( hh: mm: s s )
par t i c i pat i on_i n_s ec : par t i c i pat i on dur at i on i n s ec onds
c ount r y : c ount r y f r om whi c h us er c onnec t ed t o t he s es s i on;
nul l i n c as e c ount r y c oul d not be det ec t ed
c i t y : c i t y f r om whi c h t hi s us er c onnec t ed t o t he s es s i on; c an
i n c as e c ount r y c oul d not be det ec t ed
pl at f or m: us er ' s pl at f or m on whi c h I SL Gr oop i s / was r unni ng
gr oop_v er s i on: I SL Gr oop v er s i on t hat us er i s / was r unni ng
s es s i on
r egi s t r ant s - ar r ay of us er s t hat r egi s t er ed f or t hi s s es s i on
us er _r egi s t r at i on_t i me: t i mes t amp of us er r egi s t r at i on
us er _ni c k : r egi s t r ant ' s ni c k name
us er _mai l : r egi s t r ant ' s emai l addr es s
s es s i on - s es s i on det ai l s
s es s i on_t y pe: t y pe of s es s i on ( Webi nar , Meet i ng, et c ) ; i f t hi
i s empt y or nul l , s es s i on t y pe was meet i ng
c an be
be nul l
i n t he
s v al ue
© 2016 ISL Online
ISL Online Web API Documentation
Methods
27
s es s on_t i t l e: s es s i on' s t i t l e
s t at us _c ode: c ur r ent s es s i on' s s t at us ( RUNNI NG, FI NI SHED, et c )
s es s i on_c ode: s es s i on' s c ode
s es s i on_owner : f ul l us er name of s es s i on owner
s es s i on_owner _i d: uni que I D of t he owner
s t op_t i me: uni x t i mes t amp of end of s es s i on
s t ar t _t i me: uni x t i mes t amp of s t ar t of s es s i on
dur at i on: s es s i on dur at i on t i me ( hh: mm: s s )
dur at i on_i n_s ec : s es s i on dur at i on i n s ec onds
par t i c i pant s : number of uni que par t i c i pant s i n al l s es s i ons
ppu: how muc h Pay Per Us e c r edi t was us ed i n t hi s s es s i on
us er s _r egi s t er ed_c ount : number of us er s t hat r egi s t er ed t o j oi n t he
s es s i on ( i n c as e of webi nar )
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
s es s i on_i d: 12345
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i on/ det ai l s / get / 1&he=J SON1
POST: ui d=: : us er @ex ampl e. c om: : mai n, t ok en=s ec r et , s es s i on_i d=12345
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i on/ det ai l s / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" s es s i on_i d" : " 12345" }
3.15
report/groop/sessions/overview/get/1
Returns general information about ISL Groop usage for a given time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API
s s o/ l ogi n/ 1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
28
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i n ques t i on
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n ques t i on
Return Values
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
s es s i ons _c ount : number of s es s i ons s t ar t ed
s es s i on_c ount _uni que: number of uni que s es s i ons s t ar t ed
s es s i ons _dur at i on: t ot al dur at i on of al l s es s i ons ( hh: mm: s s )
s es s i on_dur at i on_i dl e: t ot al s es s i ons i dl e t i me ( onl y one per s on was i n
t he s es s i on)
ppu: ammount Pay Per Us e us ed by I SL Gr oop s es s i ons ( hh: mm: s s )
par t i c i pant s _c ount : number of us er s i n al l s es s i ons
par t i c i pant s _c ount _uni que: number of uni que us er s i n al l s es s i ons
l i c ens es _max : hi ghes t number of l i c ens es us ed by a s i ngl e s es s i on
s es s i on_dur at i on_av er age: av er age l engt h of a s es s i on
par t i c i pant s _c ount _av er age: av er age number
of
par t i c i pant s i n t he
s es s i ons
s es s i ons _c ount _uni que_per c ent : per c ent age of uni que s es s i ons
par t i c i pant s _c ount _uni qi e_per c ent : per c ent age of uni que us er s
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" }
© 2016 ISL Online
ISL Online Web API Documentation
3.16
Methods
29
report/groop/sessions/overview/usage/get/1
Returns ISL Groop usage for each time unit in requested time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ us age/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
J SON d a t a o b j e c t r ows - ar r ay of
uni t : uni x t i
v al ue: dur at i
s es s i on_c ount
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
t i me uni t s
mes t amp of s t ar t of t he t i me uni t
on of al l s es s i ons i n t hi s t i me uni t ( hh: mm: s s )
: number of s es s i ons s t ar t ed i n t hi s t i me uni t
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
© 2016 ISL Online
ISL Online Web API Documentation
Methods
30
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ us age/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / gr oop/ s es s i ons / ov er v i ew/ us age/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.17
report/license/usage/get/1
Returns hosted service license usage for each time unit in requested time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i c ens e/ us age/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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 mes t amp of s t ar t of t he t i me uni t
s es s i on_l i ght : number of I SL Li ght s es s i ons i n t hi s t i me uni t
s es s i on_gr oup: number of I SL Gr oop s t ar t ed i n t hi s t i me uni t
v al ue: max . l i c ens e us age i n t hi s t i me uni t
max _c onnec t i ons : max . number of c onc ur r ent c onnec t i ons i n t hi s t i me
uni t
© 2016 ISL Online
ISL Online Web API Documentation
Methods
31
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i c ens e/ us age/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i c ens e/ us age/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.18
report/light/sessions/overview/get/1
Returns general information about ISL Groop usage for a certain time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i n ques t i on
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n ques t i on
© 2016 ISL Online
ISL Online Web API Documentation
Methods
32
Return Values
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
s es s i ons _c ount : number of s es s i ons s t ar t ed
s es s i ons _dur at i on: t ot al dur at i on of al l s es s i ons ( hh: mm: s s )
s es s i ons _dat a_t r ans f er ed: t ot al dat a t r af f i c i n al l s es s i ons
ppu: Pay Per Us e us ed by I SL Li ght s es s i ons ( hh: mm: s s )
s es s i ons _c ount _ppu: number of s es s i ons t hat r equi r ed Pay Per Us e
s es s i ons _dur at i on_mobi l e: t ot al dur at i on of al l s es s i ons f r om mobi l e
dev i c es ( hh: mm: s s )
s es s i ons _c ount _by _pl at f or m - ar r ay of k ey - v al ue pai r s : " pl at f or m" :
" number _of _s es s i ons "
s es s i ons _c ount _mobi l e: number of s es s i ons s t ar t ed f r om mobi l e dev i c es
s es s i ons _c ount _mobi l e_per c ent : per c ent age of mobi l e s t ar t ed s es s i ons
s es s i ons _dur at i on_av er age: av er age l engt h of a s es s i on
s es s i ons _dur at i on_mobi l e_av er age: av er age l engt h of a mobi l e s t ar t ed
s es s i on
s es s i ons _c ount _ppu_per c ent : per c ent age of s es s i ons t hat r equi r ed Pay Per
Us e
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" }
3.19
report/light/sessions/overview/usage/get/1
Returns ISL Light usage for each time unit in requested time period.
Call
© 2016 ISL Online
ISL Online Web API Documentation
Methods
33
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ us age/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng i n v i a API s s o/ l ogi n/ 1 met hod
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i n ques t i on
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n ques t i on
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
Return Values
J SON d a t a o b j e c t r ows - ar r ay of
uni t : uni x t i
v al ue: t ot al
s es s i on_c ount
Al l f i e l d s
uni t s
mes t amp of
dur at i on of
: number of
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
s t ar t of t he t i me uni t
al l s es s i ons ( hh: mm: s s )
s es s i ons s t ar t ed
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ us age/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / l i ght / s es s i ons / ov er v i ew/ us age/ get / 1&he=J SON1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en"
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.20
:
34
" s ec r et " ,
report/ppu/status/get/1
Returns Pay Per Use usage for requested time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ppu/ s t at us / get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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 mes t amp of s t ar t of t he t i me uni t
v al ue: Pay Per Us e us age ( hh: mm: s s )
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
© 2016 ISL Online
ISL Online Web API Documentation
Methods
35
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ppu/ s t at us / get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / ppu/ s t at us / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " 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.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ c hat / ov er v i ew/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
J SON d a t a o b j e c t - Al l
r ows - ar r ay of uni t
O2O: s t at i s t i c s f
uni t : uni x
dur at i on: t
wai t _t i me:
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
s
or Oper at or t o Oper at or c hat s
t i mes t amp of s t ar t of t he t i me uni t
ot al dur at i on of c hat s i n t he t i me uni t
t ot al wai t t i me f or c hat s i n t hi s t i me uni t
© 2016 ISL Online
ISL Online Web API Documentation
Methods
36
c hat s : t ot al c hat s i n t hi s t i me uni t
V2O: s t at i s t i c s f or Vi s i t or t o Oper at or c hat s
uni t : uni x t i mes t amp of s t ar t of t he t i me uni t
dur at i on: t ot al dur at i on of c hat 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 c hat s i n t hi s t i me uni t
c hat s : t ot al c hat s i n t hi s t i me uni t
ov er v i ew: s t at i s t i c s ov er v i ew of c hat s
O2O: ov er v i ew f or Oper at or t o Oper at or c hat s
oper at or _s t ar t : s houl d al way s be t ( as t r ue) - def i nes
t hat t hi s i s i ndeed O2O c hat
dur at i on: t ot al dur at i on i n s ec onds
wai t _t i me: t ot al wai t t i me i n s ec onds
c hat s : t ot al c hat s
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or eac h c hat
V2O: ov er v i ew f or Vi s i t or t o Oper at or c hat s
oper at or _s t ar t : s houl d al way s be f ( as f al s e) - def i nes
t hat t hi s i s i ndeed V2O c hat
dur at i on: t ot al dur at i on i n s ec onds
wai t _t i me: t ot al wai t t i me i n s ec onds
c hat s : t ot al c hat s
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or eac h c hat
c hat s _mi s s ed: how many c hat s wer e unans wer ed
c hat s _mi s s ed_per c ent age: how many c hat s wer e unans wer ed
i n per c ent s
of f l i ne_mes s age: how many of f l i ne mes s ages wer e l ef t
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ c hat / ov er v i ew/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ c hat / ov er v i ew/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
© 2016 ISL Online
ISL Online Web API Documentation
3.22
Methods
37
report/pronto/supporters/overview/get/1
Returns the overview of V2O chats for each supporter in the domain.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ s uppor t er s / ov er v i ew/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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
ar r ay of s uppor t er ' s obj ec t s ( dat a di s pl ay ed i s onl y f or V2O c hat s )
c hat s : number of t ot al c hat s
dur at i on: dur at i on of c hat s i n s ec onds
wai t _t i me: t ot al wai t t i me i n s ec onds
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or a c hat
name: s uppor t er ' s name
ni c k : s uppor t er ' s ni c k
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
© 2016 ISL Online
ISL Online Web API Documentation
Methods
38
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ s uppor t er s / ov er v i ew/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ s uppor t er s / ov er v i ew/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.23
report/pronto/overview/hours/get/1
Returns the overview of chats for each hour of the day.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ hour s / get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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
ar r ay hour s ( 0- 23)
O2O: ov er v i ew f or Oper at or t o Oper at or c hat s
oper at or _s t ar t : s houl d al way s be t ( as t r ue) - def i nes
t hi s i s i ndeed O2O c hat
hour : hour of day
t hat
© 2016 ISL Online
ISL Online Web API Documentation
Methods
wai t _t i me: t ot al wai t t i me i n s ec onds
c hat s : t ot al c hat s
dur at i on: t ot al dur at i on i n s ec onds
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or eac h c hat
V2O: ov er v i ew f or Vi s i t or t o Oper at or c hat s
oper at or _s t ar t : s houl d al way s be f ( as f al s e) - def i nes
t hi s i s i ndeed V2O c hat
hour : hour of day
wai t _t i me: t ot al wai t t i me i n s ec onds
c hat s : t ot al c hat s
dur at i on: t ot al dur at i on i n s ec onds
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or eac h c hat
t ot al _c hat s : t he number of al l c hat s i n t he c ur r ent per i od
39
t hat
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ hour s / get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ hour s / get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.24
report/pronto/overview/filters/get/1
Returns the overview of chats for each filter in the domain.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ f i l t er s / get / 1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
40
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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
ar r ay of f i l t er s
t ot al _c hat s : number of t ot al c hat s f or t hi s f i l t er
mi s s ed_c hat s : number of mi s s ed c hat s f or t hi s f i l t er
oper at or s : obj ec t of oper at or obj ec t s
oper at or us er name:
c hat s : t ot al c hat s
dur at i on: t ot al dur at i on i n s ec onds
wai t _t i me: t ot al wai t t i me i n s ec onds
av g_dur at i on: av er age dur at i on of a c hat
av g_wai t _t i me: av er age wai t t i me f or eac h c hat
t ot al _c hat s : t he number of al l c hat s i n t he c ur r ent per i od
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ f i l t er s / get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ ov er v i ew/ f i l t er s / get / 1&he=J SON1
© 2016 ISL Online
ISL Online Web API Documentation
Methods
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en"
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.25
:
41
" s ec r et " ,
report/pronto/messages/offline/get/1
Returns the overview of offline messages for each unit the the requested time period.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ mes s ages / of f l i ne/ get / 1
Parameters
t ok en [ s t r i ng] ( r equi r ed)
aut hent i c at i on t ok en c an be ac qui r ed by
met hod
ui d [ s t r i ng] ( r equi r ed)
us er i d c an be ac qui r ed by l oggi ng v i a API
f r om [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he s t ar t of t he per i od i
t o [ i nt eger ] ( r equi r ed)
uni x t i mes t amp of t he end of t he per i od i n
uni t [ s t r i ng] ( r equi r ed)
onl y ' day ' i s s uppor t ed f or now
l oggi ng v i a API
s s o/ l ogi n/ 1
s s o/ l ogi n/ 1 met hod
n ques t i on
ques t i on
Return Values
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
ar r ay of uni t s
uni t : uni x t i mes t amp of s t ar t of t he t i me uni t
v al ue: number of l ef t mes s ages i n t he t i me uni t
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: : : us er @ex ampl e. c om: : mai n
t ok en: s ec r et
f r om: 1356998400
t o: 1359676800
uni t : day
© 2016 ISL Online
ISL Online Web API Documentation
Methods
42
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ mes s ages / of f l i ne/ get / 1&he=J SON1
POST:
ui d=: : us er @ex ampl e. c om: : mai n,
t ok en=s ec r et ,
f r om=1356998400,
t o=1359676800, uni t =day
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- r epor t / 1- 0/ i s l onl i ne- r epor t . php?
met hod=r epor t / pr ont o/ mes s ages / of f l i ne/ get / 1&he=J SON1
POST: j s on={ " ui d" : " : : us er @ex ampl e. c om: : mai n" , " t ok en" : " s ec r et " ,
" f r om" : " 1356998400" , " t o" : " 1359676800" , " uni t " : " day " }
3.26
sso/login/1
Executes single sign on login procedures for passed credentials.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ 1
Parameters
UI D [ s t r i n g ] ( r e q u i r e d )
us er ' s uni que i ndet i f i er
p a s s wo r d [ s t r i n g ] ( r e q u i r e d )
Return Values
J SON d a t a o b j e c t
l ogi n - l ogi n i nf or mat i on f or s uc c es s f ul us er s
UI D - us er ' s uni que I d
domai n_name - domai n name, empt y i f none i s s et
us er _name - us er ' s us er name
emai l _addr es s - c ont ac t emai l addr es s
f ul l _name - us er ' s f ul l name
ac c ount _t y pe - c an be one of t he f ol l owi ng: mai n, www, addi t i onal
t ok en - aut hent i c at i on t ok en, needed f or API aut hent i c at i on, wher e
r equi r ed
webs i d - s es s i on I D f or c onnec t i ng t o Conf er enc e Pr ox y
© 2016 ISL Online
ISL Online Web API Documentation
Methods
43
Example
PARAMETERS
r es pons e enc odi ng: J SON
ui d: domai n: : us er @ex ampl e. c om: : mai n
pas s wor d: s ec r et
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ 1&he=J SON1&ui d=domai n: : us er %
40ex ampl e. c om: : mai n&pas s wor d=s ec r et
POST: ui d: domai n: : us er @ex ampl e. c om: : mai n, pas s wor d=s ec r et
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ 1&he=J SON1
POST: j s on={ " ui d" : " domai n: : us er @ex ampl e. c om: : mai n" , " pas s wor d" :
" s ec r et " }
3.27
sso/login/get/1
Returns all successful authentication on all ISL Online user databases.
Call
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ get / 1
Parameters
l ogi n [ s t r i ng] ( r equi r ed)
t hi s c an be us er name or c ont ac t emai l addr es s
p a s s wo r d [ s t r i n g ] ( r e q u i r e d )
Return Values
J SON d a t a o b j e c t
l ogi n
us er s - ar r ay of us er s t hat mat c hed s ent c r edent i al s
UI D: us er ' s uni que I D
domai n_name: domai n name, empt y i f none i s s et
us er _name: us er ' s us er name
emai l _addr es s : c ont ac t emai l addr es s
f ul l _name: us er ' s f ul l name
© 2016 ISL Online
ISL Online Web API Documentation
Methods
44
ac c ount _t y pe: c an be one of t he f ol l owi ng: mai n, www, addi t i onal
Example
PARAMETERS
r es pons e enc odi ng: J SON
l ogi n: us er @ex ampl e. c om
pas s wor d: s ec r et
POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ get / 1&he=J SON1
POST: l ogi n=us er @ex ampl e. c om, pas s wor d=s ec r et
J SON POST
ht t ps : / / www. i s l onl i ne. c om/ api / i s l onl i ne- s s o/ 1- 0/ i s l onl i ne- s s o. php?
met hod=s s o/ l ogi n/ get / 1&he=J SON1
POST: j s on={ " l ogi n" : " us er @ex ampl e. c om" , " pas s wor d" : " s ec r et " }
© 2016 ISL Online
ISL Online Web API Documentation
4
jQuery plugin v1.0
45
jQuery plugin v1.0
jQuery plugin is a simple way to access ISL Online Account API from web sites. It
requires jQuery 1.0 or higher. All calls in jQuery plugin are made witj JSONP encoding
(due to possible cross-domain request). You cannot create multiple jobs in hosted
services methods using this plugin.
Usage
$(" #element-id" ).('method', { options });
where method is any of the supported methods (see Methods section for more
information). Plugin will search for required fields inside the element. Fields must be
marked with correct class name (ie. class="username" for username field). Method can
be called on any container element. Element with classname submit will act as submit
button when clicked.
Example:
<! doc t y pe ht ml >
<ht ml >
<head>
<met a ht t p- equi v =" c ont ent - t y pe" c ont ent =" t ex t / ht ml ; c har s et =ut f - 8" / >
<t i t l e>Tes t page f or API </ t i t l e>
<s c r i pt t y pe=" t ex t / j av as c r i pt " s r c =" j quer y - 1. 7. 1. mi n. j s " ></ s c r i pt >
<s c r i pt t y pe=" t ex t / j av as c r i pt " s r c =" i s l onl i ne. ac c ount . j quer y . j s " ></
s c r i pt >
<s c r i pt t y pe=" t ex t / j av as c r i pt " >
f unc t i on doAf t er Logi n( ) { al er t ( ' Logi n s uc c es s f ul ' ) ; }
f unc t i on doLogi nFai l ed( ) { al er t ( ' Logi n f ai l ed' ) ; }
$( doc ument ) . r eady ( f unc t i on ( ) {
$( ' #l ogi n' ) . i s l onl i ne( ' ac c ount Logi n' , { onSuc c es s :
' doAf t er Logi n' , onFai l : ' doLogi nFai l ed' } ) ;
});
</ s c r i pt >
</ head>
<body >
<h1>Logi n</ h1>
<di v i d=" l ogi n" >
Emai l : <i nput t y pe=" t ex t " c l as s =" us er name" / ><br / >
Pas s wor d: <i nput t y pe=" t ex t " c l as s =" pas s wor d" / ><br / >
<i nput t y pe=" but t on" c l as s =" s ubmi t " v al ue=" Logi n" / >
</ di v >
</ body >
</ ht ml >
As you can see, login was executed on fields inside login div. On succesful login,
doAfterLogin function is called and on failed login, doLoginFailed executes.
Available options
© 2016 ISL Online
ISL Online Web API Documentation
jQuery plugin v1.0
46
- resellerId [integer]
Set reseller ID. If none is set HQ's ID is set by default
- timezone [integer]
timezne offset in minutes
- onError [callback]
Which function to execute if error occurs.
- onFail [callback]
Which function to call if method response is METHOD_FAIL. This does not mean, that
there was an error while executing method on API side, it usually means data was
inconsistent with the requested method.
- onSuccess [callback]
Which function to call if method returns OK.
© 2016 ISL Online