Simphony Transaction Services Gen2 API Guide

PUT creates or updates integrators registration

put

{basePath}/notifications/registration

The API is used to register or update subscriber. Intended to be used when subscriber's keyId, hmacKey, or keyType update is required. Existing subscriptions will remain intact and any notifications that are sent related to the subscription will utilize the newly updated details.

Request

Supported Media Types

application/json

The SubscriberSecretView

Root Schema : SubscriberSecretView

Type: object

A subscriber subset excluding subscriberId

Show Source

hmacKey(required): string

HMACSHA256 key. Min 32bytes encoded as Base64 string.
keyId(required): string

Identifier(GUID)
keyType(required): string

Currently the only allowed value is "hmac-sha256"

{
    "description":"A subscriber subset excluding subscriberId",
    "type":"object",
    "required":[
        "keyId",
        "hmacKey",
        "keyType"
    ],
    "properties":{
        "keyId":{
            "description":"Identifier(GUID)",
            "type":"string"
        },
        "hmacKey":{
            "description":"HMACSHA256 key. Min 32bytes encoded as Base64 string.",
            "type":"string"
        },
        "keyType":{
            "description":"Currently the only allowed value is \"hmac-sha256\"",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

201 Created

Headers

Content-Location: string(url)

URL for resource that was created

204 Response

204 No Content

Examples

Example Request Body

The following example shows the contents of the request body in JSON format:


{
  "keyId": "string",
  "hmacKey": "string",
  "keyType": "string"
}

Example Response Body

Not applicable for this endpoint.