![background image](http://html.mh-extra.com/html/sick/tdc-b100/tdc-b100_operating-instructions-manual_1264311092.webp)
7
MONITORING
92
8021804/2017-11-27|SICK
T R A N S L A T I O N O F T H E O R I G I N A L I N S T R U C T I O N S | Telematic Data Collector
Subject to change without notice
7.4
Transferring data to a customer application using an API interface
The REST-based platform API for the gateway system
provides a number of ways of
connecting external applications to the SICK online portal.
As a general rule, communication with the platform API uses XML data format.
Requests sent to the REST platform are transmitted via the HTTP requests
ContentType
and
Accept
in XML forms.
Responses to REST requests are likewise returned in XML data format.
As the REST service does not have its own encryption method, the HTTPS protocol is used
to guarantee that communication between external systems and the SICK online portal is
secure.
The B2B user name and password, and a B2B external system ID are used for
authentication on the REST platform.
Please get in touch with the SICK Customer Support team to receive and activate the
connection data required to connect to the REST platform.
Testing REST services
SoapUI
can be used to systematically test REST services free of charge.
The application
provides a straightforward way of sending HTTPS requests and response analyses, and in
turn of configuring access to platform API services.
7.4.1
Input parameter
Description
Returns input activities for given objects input in some period.
Path
/Feed/{b2bUsername}/{b2bPassword}/{externSystem}/
Inputs/InputActivity
Successful
response
Status code
200
MIME type
application/xml
B2B authentication
failed response
Status code
403
MIME type
application/xml
Status description
Authentication failed
Wrong parameters
response
Status code
400
MIME type
application/xml
Status description
Bad request
Unknown error
response
Status code
503
MIME type
application/xml
Status description
Service unavailable
Extern system parameter names
Parameter type
Parameter description
ObjectId
Integer
ID of the object
InputId
Integer
ID of input
DateTimeFrom
DateTime
UTC period from which input activity
will be searched
DateTimeTo
DateTime
UTC period to which input activity will
be searched
Note
Parameters
required