Synology DS418 Transactions in Surveillance Station 8.1.0 and above - Page 27

Send Transactions Using WebAPI, Authentication, API format

Page 27 highlights

Send Transactions Using WebAPI Send Transactions Using WebAPI You can transmit transaction data from transaction devices added in Surveillance Station using Surveillance Station WebAPI, the WebAPI provided by Surveillance Station. In this chapter, we will provide detailed instructions on how to use Surveillance Station WebAPI to transmit data. Note: If you wish to connect with the transaction device on the recording server, please send WebAPI directly to the recording server instead of the host server. Authentication Authentication is required before using any WebAPI provided by Synology. For more information on the login process, please refer to 2.1.2 Operation flow and 2.3.2 SYNO.API. Auth in this document. For API methods related to sending transactions, you can specify account and password as parameters to log in to NAS directly. API format Synology WebAPI requests are implemented based on HTTP format. All the transaction operations are defined under the WebAPI, SYNO.SurveillanceStation.Transactions. Transaction. Therefore, the basic request format is as follows: http//{ip}:{port}/WebAPI/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&me thod=&version=[&] Tag Description Method of API Version of API Parameter list for the method of API An example for canceling a transaction: http://192.168.2.3:5000/WebAPI/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transact ion&method=Cancel&version=2&deviceName=POS01&sessionId=1 26

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35

26
Send Transactions Using WebAPI
Send Transactions Using WebAPI
You can transmit transaction data from transaction devices added in Surveillance Station using
Surveillance Station WebAPI,
the WebAPI provided by Surveillance Station. In this chapter,
we will provide detailed instructions on how to use S
urveillance Station WebAPI
to transmit
data.
Note:
If you wish to connect with the transaction device on the recording server,
please send WebAPI directly to the recording server instead of the host server.
Authentication
Authentication is required before using any WebAPI provided by Synology. For more
information on the login process, please refer to
2.1.2 Operation flow
and
2.3.2 SYNO.API.
Auth
in this
document
.
For API methods related to sending transactions, you can specify account and password as
parameters to log in to NAS directly.
API format
Synology WebAPI requests are implemented based on HTTP format. All the transaction
operations are defined under the WebAPI,
SYNO.SurveillanceStation.Transactions.
Transaction
. Therefore, the basic request format is as follows:
http//{ip}:{port}/WebAPI/entry.cgi?api=SYNO.SurveillanceStation.Transactions.Transaction&me
thod=<METHOD>&version=<VERSION>[&<PARAM_LIST>]
Tag
Description
<METHOD>
Method of API
<VERSION>
Version of API
<PARAM_LIST>
Parameter list for the method of API
An example for canceling a transaction:
ion&method=Cancel&version=2&deviceName=POS01&sessionId=1