Redeam Notifications 0.1.0

The Redeam Notification service can provide notification via the Notification Registry.

Channelbinding

Channel Binding notifications

Receive a channelbinding notification.

Receive a channelbinding notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for channelbinding notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
operation	string	What type of channelbinding operation was performed. Enum: `created`,`removed`,`updated`
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

POST /channelbinding

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/channelbinding' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "created",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received

No response body

Response

xxxxxxxxxx
 
No response
Copy

Supplier

Supplier notifications

POST

/supplier

Receive a supplier notification.

Receive a supplier notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for supplier notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
operation	string	What type of supplier modification was performed. Enum: `updated`
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

POST /supplier

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/supplier' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Product

Product notifications

POST

/product

Receive a product notification.

Receive a product notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for product notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
operation	string	The product operation. Since product visibility is controlled by channel bindings, those interested in new and removed products should subscribe to channel bindings. Enum: `updated`
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

POST /product

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/product' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Rate

Rate notification

POST

/rate

Receive a rate notification.

Receive a rate notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for rate notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
rateID	string	The Booking-API Rate ID
operation	string	The rate operation. Since rate visibility is controlled by channel bindings, those interested in new and removed rates should subscribe to channel bindings. Enum: `updated`
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

Expand

POST /rate

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/rate' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "rateID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Availability

Availability notifications

POST

/availability

Receive an availability notification

Receive an availability notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for availability notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
rateID	string	The Booking-API Rate ID.
start	string	An RFC-3339 start time.
end	string	An RFC-3339 end time.
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

Expand

POST /availability

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/availability' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "rateID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "start": "2024-01-18T10:05:15.000Z",  "end": "2024-01-18T10:05:15.000Z",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Priceschedule

Price Schedule notifications

POST

/priceschedule

Receive a priceschedule notification

Receive a priceschedule notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for priceschedule notifications.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
start	string	An RFC-3339 start time.
end	string	An RFC-3339 end time.
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

POST /priceschedule

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/priceschedule' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "start": "2024-01-18T10:05:15.000Z",  "end": "2024-01-18T10:05:15.000Z",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received

No response body

Response

xxxxxxxxxx
 
No response
Copy

Booking

Booking notifications

POST

/booking

Receive a booking notification.

Receive a booking notification. The path here is not strict, this is specified in the Notification Rule supplied when registering for booking notifications.

Auth

Request Body

object	object
bookingID	string	The Booking-API Booking ID.
startTime	string	The booking start time.
resellerBookingReference	string	The reseller booking reference, if available.
operation	string	The booking operation Enum: `canceled`,`tickets-added`
signature	object	A signature object to validate the origin of a notification. The sum can be validated by generating a SHA256 HMAC using the Notification Rule's SecurityKey, the unix timestamp and the token. See the `CalcSig` function in the following example. package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func CalcSig(secret, token string, ts int64) (string, error) { h := hmac.New(sha256.New, []byte(secret)) _, err := h.Write([]byte(fmt.Sprintf("%d%s", ts, token))) if err != nil { return ``, err } return hex.EncodeToString(h.Sum(nil)), nil }
sum	string	A hexadecimal encoded string representation of a generated SHA256 HMAC checksum.
timestamp	number	A unix timestamp representing when the signature sum was generated.
token	string	A unique token included when generating the signature.

Expand

POST /booking

xxxxxxxxxx
 
curl --request POST \ --url 'https://docs.redeam.io/booking' \ --data '{  "bookingID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "startTime": "2024-01-18T10:05:15.000Z",  "resellerBookingReference": "BR0987654321",  "operation": "canceled",  "signature": {    "sum": "e2885631a81ed00ad9606a0a6ce2f1efdcf355a9785e0dc1ff027b039a95c820",    "timestamp": 1727715823,    "token": "2915c9b2-9cd9-4baf-b5b7-79d95ea3eb2c"  }}'
Copy

Responses

200

Notification received.

No response body

Response

xxxxxxxxxx
 
No response
Copy