Access Control Webhook

Description

This webhook is proposed to integrate with an access control system and is designed in that sense.

It is not designed to be used as a generic "ticket" webhook. Please use it only to connect S360 with an access control system.

Behaviour

There are two ways to execute this webhook:

  • In a manual way.
  • Automatic way, every M minutes.

S-360 does POST all the tickets of the Visit Pass/Performance/Event in the form of a JSON object.

Url and http method

Url

The callee must provide a URL.

Any POST URL can be used in this webhook.

Http method

The URL will be called using POST method.

Setup in backend

  1. Ask for a proxy opening for the destination URL.
  2. In organization/tools/external interfaces create a new interface of type Control Interfaces/Access control webhook
  3. Paste the url in the Url field
  4. Choose the authentication mode : NONE, BASIC_AUTH, API_KEY
    1. NONE : nothing else to do
    2. BASIC_AUTH : put the login in the login field, the password in the password field
    3. API_KEY : put the name of the header (e.g. -x-api-key) in the login field. The key in the password field
  5. In the schedule menu, create a new schedule.
  6. Enter N into the Batch size field. (default value: 1)
  7. Give the Visit Pass/Performance/Event code and datetime (code;DD/MM/(YY or YYYY) hh:mm format)
  8. Save by clicking on "Schedule"

Tickets JSON example

[
   {
      "barcode": "2276812732345698540800199237",
      "ticketId": 10228305597652,
      "ticketState": "VALID",
      "cancellationCause": "NOT_CANCELLED",
      "tariffCode": "CPGRTKT",
      "productId": 101095635789,
      "productCode": "SCHL",
      "validityStartTime": "2021-10-08T16:00:00.000+02:00",
      "culturalContactNumber": "124",
      "holderInfo": {},
      "validityEndTime": "2022-10-08T16:00:00.000+02:00",
      "salesChannelCodeMapping": "BO",
      "orderId": 10000404884,
      "creationDate": "2020-09-23T04:38:48.909+02:00",
      "groupSize": 10,
      "price": 85000
   },
   {
      "barcode": "2452941492091912458400132443",
      "ticketId": 10228404119314,
      "ticketState": "VALID",
      "cancellationCause": "NOT_CANCELLED",
      "tariffCode": "CPGRTKT",
      "productId": 101095635789,
      "productCode": "SCHL",
      "validityStartTime": "2021-10-27T11:00:00.000+02:00",
      "culturalContactNumber": "106",
      "holderInfo": {},
      "validityEndTime": "2022-10-27T11:00:00.000+02:00",
      "salesChannelCodeMapping": "B2C",
      "orderId": 10000405495,
      "creationDate": "2021-08-24T05:10:34.597+02:00",
      "groupSize": 5,
      "price": 50000
   },
   {
      "barcode": "0764921489355619004400132482",
      "ticketId": 10228404119315,
      "ticketState": "VALID",
      "cancellationCause": "NOT_CANCELLED",
      "tariffCode": "CPGRTKT",
      "productId": 101095635789,
      "productCode": "SCHL",
      "validityStartTime": "2021-10-27T11:00:00.000+02:00",
      "culturalContactNumber": "106",
      "holderInfo": {},
      "validityEndTime": "2022-10-27T11:00:00.000+02:00",
      "salesChannelCodeMapping": "B2C",
      "orderId": 10000405495,
      "creationDate": "2021-08-24T05:10:34.598+02:00",
      "groupSize": 5,
      "price": 50000
   },
   {
      "barcode": "0236124824128697718400133805",
      "ticketId": 10228352025535,
      "ticketState": "VALID",
      "cancellationCause": "NOT_CANCELLED",
      "tariffCode": "CPGRTKT",
      "productId": 101095635789,
      "productCode": "SCHL",
      "validityStartTime": "2021-10-06T12:00:00.000+02:00",
      "holderInfo": {},
      "validityEndTime": "2022-10-06T12:00:00.000+02:00",
      "salesChannelCodeMapping": "BO",
      "orderId": 10000405208,
      "creationDate": "2021-04-23T05:13:10.338+02:00",
      "groupSize": 10,
      "price": 90000
   },
   {
      "barcode": "2924224662097669216800132572",
      "ticketId": 10228352025537,
      "ticketState": "VALID",
      "cancellationCause": "NOT_CANCELLED",
      "tariffCode": "CPGRTKT",
      "productId": 101095635789,
      "productCode": "SCHL",
      "validityStartTime": "2021-10-09T15:00:00.000+02:00",
      "culturalContactNumber": "650",
      "holderInfo": {},
      "validityEndTime": "2022-10-09T15:00:00.000+02:00",
      "salesChannelCodeMapping": "BO",
      "orderId": 10000405213,
      "creationDate": "2021-04-23T05:33:49.953+02:00",
      "groupSize": 5,
      "price": 50000
   }
]