Dokumentation. Udbyder : sms1919.dk Service : profiling Version : v1.10

Transkript

1 Dokumentation Udbyder : sms1919.dk Service : profiling Version : v1.10

2 Indholdsfortegnelse Versionshistorik... 3 Brug af profileringskaldet... 4 URL... 4 Obligatoriske værdier... 4 Valgfrie parametre... 5 Profilinformationer... 6 Brug af login... 7 Reseller... 7 Slutkunde... 7 Reseller subscription... 8 Keywords... 9 Subscriptions Billing Termination Charged

3 Versionshistorik Dokumentationen bliver løbende opdateret, og her finder du datoer og kort beskrivelse af hvad der er blevet opdateret. Dato og version 9. marts, 2009 v maj, 2009 v maj, 2009 v september, 2015 v1.10 Ændringer Original udgivelse af profiling-dokumentationen Tilføjede login-informationer Tilføjede afsnit omkring brug af login-informationerne Tilføjede abonnementsoplysninger på resellerens retur-xml Opdaterede pakkeoplysninger til at indeholde både indkøbs- og salgspris. Opdatering af API-url (Krav om SSL mod api.sms1919.dk) 3

4 Brug af profileringskaldet Ved brug af dette kald kan du generere en oversigt over samtlige resellerinformationer, kunder, keywords, pakkevalg og faktureringsoplysninger. URL For at benytte sig af APIen sendes en række parametre til nedenstående URL med enten post eller get: Obligatoriske værdier Følgende felter er obligatoriske og skal som minimum indgå i dit URL-kald: Navn Værdi Type Eksempel username Dit brugernavn til sms1919.dk Tekststreng Bruger007 password Din adgangskode til sms1919.dk. Tekststreng Hemmelig112 from to Tidspunkt hvor du ønsker udtrækket fra Tidspunkt angives: ååååmmddttnnss Tidspunkt hvor du ønsker udtrækket til Tidspunktet er inklusiv i udtrækket Tal Tal

5 Valgfrie parametre Disse parametre er valgfrie, men åbner hver især op til en bred vifte af oplysninger som du kan fakturere efter. Af hensyn til performance bør du kun benytte dig af de ekstra informationer som er nødvendigt i dit udtræk, eftersom nogle af kaldende kan tage noget tid at svare på. Navn Værdi Type Eksempel login Sættes værdien til 1, vil brugernavn og logintoken Tal 1 blive leveret. keywords subscriptions billing Sættes værdien til 1, vil keywords blive vist for den enkelte kunde Sættes værdien til 1, vil pakkevalg blive vist for den enkelte kunde Sættes værdien til 1, vil billinginformationer blive vist for den enkelte kunde. Disse er fordelt på hhv. termineringsafgifter og overtakseringsprofit Tal 1 Tal 1 Tal 1 5

6 Profilinformationer Hver profilsektion indeholder en række profilinformationer. <reseller> <id>1234</id> <created> :25:19</created> <deleted /> <company>virksomhedsnavn</company> <cbr> </cbr> <name>kontaktpersonens navn</name> <address>virksomhedsvej 123</address> <zip>8660</zip> <city>skanderborg</city> <country>dk</country> <region /> <login> <username>brugernavn</username> <password>abcdef abcdef </password> </login> <subscriptions /> <customers> <customer> <id>2345</id> <created> :54:47</created> <deleted /> <company>virksomhedsnavn</company> <cbr> </cbr> <name>kontaktpersonens navn</name> <address>virksomhedsvej 234</address> <zip>8660</zip> <city>skanderborg</city> <country>dk</country> <region /> <login> <username>brugernavn</username> <password>abcdef abcdef </password> </login> <keywords /> <subscriptions /> <billing /> </customer> </customers> </reseller> 6

7 Brug af login Såfremt der ønskes automatisk login fra andre systemer kan <login>-sektionen benyttes. Den indeholder det brugernavn og den adgangshash som kan benyttes til at brugeren får en mere naturlig og integreret oplevelse af systemet, såfremt SMS1919 benyttes i et allerede eksisterende setup. Login-informationerne skal sendes til følgende adresser: Reseller Reselleren skal sendes til følgende URL for automatisk at blive logget ind: Slutkunde Slutkunden skal sendes til følgende URL for automatisk at blive logget ind: 7

8 Reseller subscription Denne sektion indeholder en liste over de i perioden aktive abonnementsforhold for reselleren. <subscriptions> <subscription> <start> :00:00</start> <end> :00:00</end> <price> </subscription> <subscription> <start> :00:00</start> <end> :00:00</end> <price>90000 </subscription> </subscriptions> <start> - Fortæller hvornår abonnementsperioden gælder fra. Gælder den fra før perioden du søger i, vil datoen være lig med periodens start. <end> - Fortæller hvornår abonnementsperioden gælder til. Gælder den efter perioden du søger i, vil datoen være lig med periodens slut. <price> - Prisen pr. måned for abonnementet 8

9 Keywords Denne sektion indeholder en liste over den pågældende kundes keywords. <keywords> <keyword> <start> :00:00</start> <end> :00:00</end> <trigger>keyword1</trigger> </keyword> <keyword> <start> :51:59</start> <end> :00:00</end> <trigger>keyword2</trigger> </keyword> <keyword> <start> :00:00</start> <end> :12:41</end> <trigger>keyword3</trigger> </keyword> <keyword> <start> :50:24</start> <end> :52:51</end> <trigger>keyword4</trigger> </keyword> </keywords> <start> <end> - Fortæller hvornår keywordet blev oprettet. Blev keywordet oprettet før perioden du søger i, vil datoen være lig med periodens start. - Fortæller hvornår keywordet blev nedlagt. Blev keywordet nedlagt efter perioden du søger i, vil datoen være lig med periodens slut. <trigger> - Triggeren er selve keywordet og er det første ord i den sms som sendes som modtages fra en brugers terminal. 9

10 Subscriptions Sektionen her lister de pakker at en given kunde har været tilknyttet indenfor den søgte periode. <subscriptions> <subscription> <start> :00:00</start> <end> :32:15</end> <package> <id>12</id> <name>professionel</name> <keywords>10</keywords> <cost_price> <subscription>29900</subscription> <keyword>5000</keyword> </cost_price> <sales_price> <subscription>39900</subscription> <keyword>5900</keyword> </sales_price> </package> </subscription> <subscription> <start> :32:15</start> <end> :00:00</end> <package> <id>7</id> <name>basis</name> <keywords>2</keywords> <cost_price> <subscription>19900</subscription> <keyword>5000</keyword> </cost_price> <sales_price> <subscription>29900</subscription> <keyword>5900</keyword> </sales_price> </package> </subscription> </subscriptions> 10

11 Subscriptions (fortsat) Beskrivelse af subscription-sektionen, fortsat fra forrige side. <start> <end> - Fortæller hvornår pakken blev tildelt. Blev pakken tildelt før perioden du søger i, vil datoen være lig med periodens start. - Fortæller hvornår pakken blev afvalgt. Blev pakken afvalgt efter perioden du søger i, vil datoen være lig med periodens slut. <package> - Indeholder informationer om den pakke som kunden har i den definerede periode <name> <keywords> <cost_price> - Navnet på pakken - Hvor mange keywords pakken indeholder - Indkøbspriser for reseller <subscription> <keyword> - Indkøbsprisen pr. måned for denne pakke - Indkøbsprisen pr. måned pr. ekstra keyword ud over det antal der er angivet i <keywords>-tagget </cost_price> <sales_price> - Resellerens salgspriser til denne kunde <subscription> <keyword> - Salgsprisen pr. måned for denne pakke - Salgsprisen pr. måned pr. ekstra keyword ud over det antal der er angivet i <keywords>-tagget </sales_price> </package> 11

12 12 Billing <billing> <termination> <price value= 0 > <messages>110</messages> <cost> <customer>2750</customer> <reseller>2530</reseller> </cost> <price value= 100 > <messages>50</messages> <cost> <customer>1500</customer> <reseller>1250</reseller> </cost> <price value= 5000 > <messages>4</messages> <cost> <customer>120</customer> <reseller>100</reseller> </cost> </termination> <charged> <price value= 100 > <messages>45</messages> <profit> <customer>810</customer> <reseller> <termination>225</termination> <share>135</share> </reseller> </profit> <price value= 5000 > <messages>3</messages> <profit> <customer>7110</customer> <reseller> <termination>15</termination> <share>450</share> </reseller> </profit> </charged> </billing>

13 Billing (fortsat) Billingsektionen er delt op I termineringsafgifter og profit fra overtakserede beskeder. Termination Termineringsafgifterne er indrammet af <termination> og indeholder følgende informationer: <price> <messages> <cost> <customer> <reseller> - Hver prisgruppe har sin egen sektion der hver har sin egen value der udgør beløbet på den udgående sms i øre. - Antallet af beskeder der er sammenregnet - Denne sektion indeholder de samlede termineringsafgifter - Prisen for kunden - Prisen for reselleren </cost> Charged Profitten fra overtakserede smser er indrammet af <charged> og indeholder følgende informationer: <price> <messages> <profit> <customer> <reseller> - Hver prisgruppe har sin egen sektion der hver har sin egen value der udgør beløbet på den udgående sms i øre. - Antallet af beskeder der er sammenregnet - Denne sektion indeholder de samlede termineringsafgifter - Kundens profit - Sektionen indeholder profit gældende for reselleren <termination> <share> - Resellerens fortjeneste på termineringsafgiften - Resellerens fortjeneste på sharen </reseller> </profit> 13