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 36 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: - 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" } } }

6 ISL Online Web API Documentation Communication model 6 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: 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

7 ISL Online Web API Documentation Methods 7 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 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 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 es s : us ampl e. c om ui d: domai n: : us ampl e. c om: : mai n pas s wor d: s ec r et r andom: 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 : emai l _addr es s =us ampl e. c om&ui d=domai n: : us ampl e. c om: : mai n&pas s wor d= s ec r et &r andom= 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 : j s on={ " emai l _addr es s " : " us ampl e. c om", " ui d" : " domai n: : us ampl e. c om: : mai n", " pas s wor d" : " s ec r et ", " r andom" : " " }

8 ISL Online Web API Documentation Methods 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 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 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 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 None domai n_name: my domai n ui d: domai n: : us ampl e. c om: : mai n t ok en: s ec r et 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 : domai n_name=my domai n&ui d=domai n: : us ampl e. c om: : mai n&t ok en=s ec r et 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 : j s on={ " domai n_name" : " my domai n", " ui d" : " domai n: : us ampl e. c om: : mai n", " t ok en" : " s ec r 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 es s.

9 ISL Online Web API Documentation Methods 9 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 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 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 ) None emai l _addr es s : us ampl e. c om 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 : emai l _addr es s =us ampl e. c om 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 : j s on={ " emai l _addr es s " : " us 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. 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

10 ISL Online Web API Documentation Methods 10 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 us er r e s e l l e r I d [ i n t e g e r ] i f no v al ue i s s et, HQ r es el l er i d i s s et a r i d [ i n t e g e r ] l ook at r es el l er I d None us er _name: us ampl e. c om pas s wor d: s ec r et ar i d: 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 : ) Gec k o/ Fi r ef ox / ", " us er Language" : " undef i ned" } 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 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 : ) Gec k o/ Fi r ef ox / \ ", \ " us er Language\ " : \ " undef i ned\ " } " 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 : j s on={ " us er _name" : " us ampl e. c om", " pas s wor d" : " s ec r et ", " ar i d" : " ", " 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 : ) Gec k o/ Fi r ef ox / \ ", \ " 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.

11 ISL Online Web API Documentation Methods 11 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 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 es s : us ampl e. c om s t ep: 1 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 ampl e. c om, s t ep=1 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={ " us er _name" : " us ampl e. c om", " s t ep" : " 1" } St e p 2 : us er _name: us ampl e. c om pas s wor d: s ec r et s t ep: 2 r andom: c ount r y _c ode: ES or i gi n: { " appcodename" : " Moz i l l a", " appmi nor Ver s i on" :

12 ISL Online Web API Documentation Methods 12 " 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 : ) Gec k o/ Fi r ef ox / ", " us er 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 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= &c ount r y _c ode=es&c ompan 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 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 ampl e. c om, pas s wor d=s ec r et, s t ep=2, r andom= , 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 : ) Gec k o/ Fi r ef ox / \ ", \ " us er Language\ " : \ " undef i ned\ " }, ar i d=333133, c ompany =My Company, f ul l _ name=ful l Name, phone_ number = 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% %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 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={ " us er _name" : " us ampl e. c om", " pas s wor d" : " s ec r et ", " s t ep" : " 2", " r andom" : " ", " c ount r y _c ode" : " ES", " ar i d" : " ", " c ompany " : " My Company ", " f ul l _name" : " Ful l Name", " phone_number " : " ", " 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 : ) Gec k o/ Fi r ef ox / \ ", \ " us er Language\ " : \ " undef i ned\ " } " }

13 ISL Online Web API Documentation Methods content/brochure/languages/get/1 Returns available brochure languages and their website paths. 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 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 - k ey - v al ue par, wher e k ey i s l anguage c ode and v al ue i s pat h t o br oc hur e y ear : 2012 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 : y ear =2012 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 : j s on={ " y ear " : " 2012" } 3.7 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 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 y e a r [ i n t e g e r ] ( r e q u i r e d )

14 ISL Online Web API Documentation Methods 14 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 s et t o pr emi um, a pr emi um br oc hur 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 y ear : 2012 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 : y ear =2012&l anguage=en 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 : j s on={ " y ear " : " 2012", " l anguage" : " en" } 3.8 content/resellers/get/1 Returns available brochure languages and their website paths. 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 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 es el l er wi t h pas s ed 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 s t of r es el l er s f or s pec i f i c c ount r y 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

15 ISL Online Web API Documentation Methods 15 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 c ount r y _c ode: US 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 : c ount r y _c ode=us 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 : 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. 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 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 ) 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 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 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

16 ISL Online Web API Documentation Methods 16 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 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. c ount r y _c ode: US 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 : c ount r y _c ode=us 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 : 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. 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 t o k e n [ s t r i n g ] ( r e q u i r e d ) 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 u i d [ s t r i n g ] ( r e q u i r e d ) 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 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 c ode pr ov i ded t o y ou 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 c ode; t hi s def i nes l oc al i z at i on l anguage o f f s e t [ i n t e g e r ] 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 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 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; 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 :

17 ISL Online Web API Documentation Methods 17 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 e r [ k e y - v a l u e p a i r a r r a y ] 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 , 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 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 EXAMPLE 1 ui d: : : us 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 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 : ui d=: : us 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

18 ISL Online Web API Documentation Methods 18 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 : j s on={ " ui d" : " : : us 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 met hod mus t be us ed! ui d: : : us 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 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 : j s on={ " ui d" : " : : us 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. 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 t o k e n [ s t r i n g ] ( r e q u i r e d ) 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 u i d [ s t r i n g ] ( r e q u i r e d ) 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 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 c ode pr ov i ded t o y ou 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 c ode; t hi s def i nes l oc al i z at i on l anguage r e s o u r c e _ i d [ i n t e g e r ] 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 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

19 ISL Online Web API Documentation Methods 19 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 ui d: : : us 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 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 : ui d=: : us 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 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 : j s on={ " ui d" : " : : us 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" } 3.12 localization/translation/single/insert/1 Inserts new translation for given translation string in single resource. 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 t o k e n [ s t r i n g ] ( r e q u i r e d ) 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 u i d [ s t r i n g ] ( r e q u i r e d ) 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 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 c ode pr ov i ded t o y ou 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 c ode; t hi s def i nes l oc al i z at i on l anguage r e s o u r c e _ i d [ i n t e g e r ] 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 o r i g i n a l _ t e x t [ s t r i n g ] 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 on/ t r ans l at i on/ s i 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 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 on/

20 ISL Online Web API Documentation Methods 20 t r ans l at i on/ s i ngl e/ get / 1 met hod 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 ui d: : : us 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 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 : ui d=: : us 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 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 : j s on={ " ui d" : " : : us 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. met hod=r epor t / ac c ount hi s t or y / s t 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 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 u i d [ s t r i n g ] ( r e q u i r e d ) 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