Ti liu kt ni Vivas WAP Charging API

Phin bn 1.0

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 1

MC LC
1

Gii thiu ........................................................................................................... 3

1.1

Mc ch .......................................................................................................... 3

1.2

Tng quan ........................................................................................................ 3

Request: CP gi n Vivas ng k xc nhn cho mt giao dch ................................... 3

Verify: CP gi n Vivas xc minh kt qu cho mt giao dch tr tin ........................... 3

Detect: Subscriber gi n Vivas ly MSISDN .......................................................... 3

Charge: Subscriber gi n Vivas thc hin giao dch tr tin ..................................... 3

M t API ............................................................................................................ 4

2.1

M t quy trnh WAP charging ................................................................................ 4

2.2

Private API ....................................................................................................... 4

2.3

Public API ........................................................................................................ 6

2.4

Bng m li ...................................................................................................... 9

2.5

Bng ID th loi content ...................................................................................... 9

2.6

Bng cc mc gi c php giao dch................................................................... 10

Ph lc ............................................................................................................. 12

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 2

1 Gii thiu
1.1 Mc ch
Ti liu m t kt ni k thut vi h thng WAP Charging API ca Vivas dnh cho cc Content Provider.

1.2 Tng quan

H thng WAP Charging API ca Vivas bao gm 4 API, hot ng trn giao thc HTTP. 4 API ny c
chia lm 2 nhm API.

1.2.1 Private API:

Cc API dnh cho CP kt ni n Vivas xc nhn v xc minh mt giao dch
-

Request: CP gi n Vivas ng k xc nhn cho mt giao dch

Verify: CP gi n Vivas xc minh kt qu cho mt giao dch tr tin

1.2.2 Public API:

Cc API dnh cho Subscriber kt ni n Vivas ly s in thoi (MSISDN) v thc hin
charging
-

Detect: Subscriber gi n Vivas ly MSISDN

Charge: Subscriber gi n Vivas thc hin giao dch tr tin

1.2.3 H thng bao gm 2 loi giao dch:

Detect MSISDN: nhn din s in thoi ng vi subscriber thc hin giao dch
Charge: tr tin cho subscriber thc hin giao dch

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 3

2 M t API
2.1 M t quy trnh WAP charging
End user

CP

Vivas

purchase
request for charging: transID
request ACK: token
redirect user to charge API

charge
redirect user to CP end point
redirected
verify
optional
charge result

delivery content

2.2 Private API

2.2.1 Request API
a. Mc ch:
API ny dnh cho CP xc nhn mt giao dch trc khi Subscriber thc hin giao dch vi
Vivas. Vic xc nhn ny l bt buc vi c 2 loi giao dch, detect MSISDN v charge
b. M t k thut
URL

Protocol

Port

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 4

m.vmobile.vn/privateAPI/request

HTTP

80

c. Tham s u vo
privateAPI/request?cpId=xxx&param=xxx
Tham s

Gi tr

M t

cpId

Content Provider Id

param

Xu k t

Chui tham s m ha

Trong chui tham s param c m ha bng AES-128 bit, vi key l encrypt key i km vi
mi CP, c cp pht khi k hp ng kt ni.
Chui trc khi m ha c dng nh sau
transactionId=xxxx&price=xxxx&contentId=xxxx
Tham s

Gi tr

M t

transactionId

Xu k t

unique id ca giao dch

price

S dng

Mc gi ca giao dch

Id ca content bn pha CP

(c th b trng ny nu
giao dch l detect)
contentId
(c th b trng ny nu
giao dch l detect)
d. Gi tr tr v
Gi tr

M t

0|token

Giao dch c xc nhn thnh cng km

theo token ca giao dch.Ngn cch bi du
gch thng |

Khc

Xem bng m kt qu

2.2.2 Verify API

a. Mc ch
API ny dnh cho CP xc minh kt qu ca mt giao dch tr tin. Vic xc minh giao dch ny
l khng bt buc, bo v CP khi cc giao dch gi.
b. M t k thut
URL
m.vmobile.vn/privateAPI/verify

Protocol
HTTP

Port
80

c. Tham s u vo
Copyright VIVAS 2011
Ti liu kt ni WAP Charging API
Page 5

/privateAPI/verify?cpId=xxx&param=xxx
Tham s

Gi tr

M t

cpId

Content Provider Id

param

Xu k t

Chui tham s m ha

Trong chui tham s param c m ha bng AES-128 bit, vi key l encrypt key i km vi
mi CP, c cp pht khi k hp ng kt ni.
Chui trc khi m ha c dng nh sau
transactionId=xxxx&price=xxxx&contentId=xxxx&msisdn=xxxx
Tham s

Gi tr

M t

transactionId

Xu k t

unique id ca giao dch

price

S dng

Mc gi ca giao dch

Id ca content bn pha CP

Xu k t

S in thoi thc hin giao

dch

(c th b trng ny nu
giao dch l detect)
contentId
(c th b trng ny nu
giao dch l detect)
msisdn

Trong transactionId l bt buc v cc tham s cn li l khng bt buc, c dng tng

mc an ton ca vic xc minh kt qu giao dch
Cc trng trn phi ging vi cc thng s gi sang khi request giao dch
d. Gi tr tr v
Gi tr

M t

Giao dch tr tin thnh cng

Khc

Xem bng m kt qu

2.3 Public API

2.3.1 Detect API
a. Mc ch
API ny dnh cho Subscriber kt ni n Vivas xc nh s in thoi ng vi subscriber .
Kt thc giao dch, subscriber s t ng c redirect v end point m CP quy nh vi kt
qu v msisdn c thm vo di dng parameter trn URL
b. M t k thut
URL
m.vmobile.vn/publicAPI/detect

Protocol
HTTP

Port
80

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 6

c. Tham s u vo
/publicAPI/detect?cpId=xxx&param=xxx
Tham s

Gi tr

M t

cpId

Content Provider Id

param

Xu k t

Chui tham s m ha

Trong chui tham s param c m ha bng AES-128 bit, vi key l encrypt key i km vi
mi CP, c cp pht khi k hp ng kt ni.
Chui trc khi m ha c dng nh sau
transactionId=xxx&timestamp=xxx&password=xxx&redirectUrl=xxx
Tham s

Gi tr

M t

transactionId

Xu k t

unique id ca giao dch

timestamp

system millisecond

Password

Xu k t

Mt khu c m ha
AES-128 bng token nhn
c thng qua request API

redirectUrl

Xu k t

Endpoint m CP quy nh
redirect subscriber sau khi
giao dch hon tt

(khng bt buc)

Nu khng cung cp trng

ny th subscriber s c
redirect v end point mc nh
ca mi CP khi k hp ng
d. Gi tr tr v
Subscriber c t ng redirect v end point theo quy nh ca CP, km theo cc tham s sau
Tham s

Gi tr

M t

cpId

Content Provider Id

Param

Xu k t

Xu m ha m subscriber
gi sang Vivas

Result

Xem bng m kt qu

Msisdn

Xu k t

Msisdn ca subscriber

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 7

CP phi implement end point ny nhn kt qu tr v ca giao dch v handle userflow ca

subscriber sau khi redirect ra khi Vivas.

2.3.2 Charge API

a. Mc ch
API ny dnh cho Subscriber kt ni n Vivas tin hnh giao dch tr tin cho s in thoi
ng vi subscriber . Kt thc giao dch, subscriber s t ng c redirect v end point m
CP quy nh vi kt qu ca giao dch v msisdn c thm vo di dng parameter trn
URL
b. M t k thut
URL

Protocol

m.vmobile.vn/publicAPI/charge

Port

HTTP

80

c. Tham s u vo
/publicAPI/charge?cpId=xxx&param=xxx
Tham s

Gi tr

M t

cpId

Content Provider Id

param

Xu k t

Chui tham s m ha

Trong chui tham s param c m ha bng AES-128 bit, vi key l encrypt key i km vi
mi CP, c cp pht khi k hp ng kt ni.
Chui trc khi m ha c dng nh sau
transactionId=xxx&timestamp=xxx&password=xxx&price=xxx&contentType=xxx&contentId=xxx
&redirectUrl=xxx
Tham s

Gi tr

M t

transactionId

Xu k t

unique id ca giao dch

timestamp

system millisecond

Password

Xu k t

Mt khu c m ha
AES-128 bng token nhn
c thng qua request API

Price

S dng

Mc gi ca giao dch

contentType

S dng

Id ca th loi content theo

quy nh ca Vivas. Xem bng
ID cc th loi content

contentId

S dng

Id ca content bn pha CP

redirectUrl

Xu k t

Endpoint m CP quy nh
redirect subscriber sau khi
giao dch hon tt

(khng bt buc)
Copyright VIVAS 2011
Ti liu kt ni WAP Charging API

Page 8

Nu khng cung cp trng

ny th subscriber s c
redirect v end point mc nh
ca mi CP khi k hp ng
d. Gi tr tr v
Subscriber c t ng redirect v end point theo quy nh ca CP, km theo cc tham s sau
Tham s

Gi tr

M t

cpId

Content Provider Id

param

Xu k t

Xu m ha m subscriber
gi sang Vivas

result

Xem bng m kt qu

msisdn

Xu k t

Msisdn ca subscriber

CP phi implement end point ny nhn kt qu tr v ca giao dch v handle userflow ca

subscriber sau khi redirect ra khi Vivas.

2.4 Bng m li
Khu vc li
Thnh cng
End user 1x

Content Provider 2x

Vivas 3x

Operator 4x
Li h thng 5x
Li truy vn

M li
0
10
20
21
22
23
24
25
26
30
31
40
41
42
50
99

Nguyn nhn
Thanh ton thnh cng
Khng detect c msisdn
CP khng tn ti
CP b kha
Li m ha
Thiu parameter trc m ha
Request cha c xc thc, khng tm thy token
Token sai, password sai
Request trng hoc transaction c thc hin
Li m ha
Khng ly c session t VMS
Pending
Thanh ton b li
Thanh ton b hy b
Khng truy cp c database
Thiu parameter hoc parameter sai

2.5 Bng ID th loi content

M

Category

Category

Category

00

Tin tc chung

20

m nhc chung

40

Clip chung

01

Thi s

21

Nhc chung

41

Phim hot hnh

02

Th thao

22

Nhc ch

42

Phim nh

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 9

03

Hi hc

23

Audiobook

43

Thi s clip

04

Gii tnh

24

Nhc Vit

44

Th thao clip

05

Ti chnh

25

Nhc quc t

45

Hi hc clip

06

Chng khon

26

46

Gii tnh clip

07

Vn ha

27

47

m nhc clip

08

Thi trang

28

48

Ngi sao clip

09

29

49

YanTV

10

30

Hnh nh chung

50

ng dng chung

11

31

Hnh nn

51

Game

12

32

Theme

52

Kt ni Wap site

13

33

53

Tra cu thng tin

14

34

54

Tm ng

15

35

55

X s

16

36

56

Livescore

17

37

57

Truyn tranh

18

38

58

Chat

19

39

59

Forum

60

Thi trang clip

60100

Khc

Thip in t

2.6 Bng cc mc gi c php giao dch

Do chnh sch ca nh mng nn i vi Vinaphone, ch cc mc gi sau c php giao dch:
Gi

Gi

300

8000

500

10000

1000

15000

2000

20000

3000

25000

5000
Mobifone khng p dng chnh sch trn. Gi phi trn 500 ng v s nguyn l 100 ng
Viettel
Gi

Gi

500

10000
Copyright VIVAS 2011
Ti liu kt ni WAP Charging API
Page 10

1000

15000

2000

20000

3000

25000

4000

30000

5000

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 11

3 Ph lc
Thut ng

Ch gii

Subscriber

Thu bao di ng

Content provider, CP

Nh cung cp ni dung

Content

Ni dung

msisdn

S thu bao

AES

Tiu chun m ha tin tin

Copyright VIVAS 2011

Ti liu kt ni WAP Charging API
Page 12