Simphony Transaction Services Gen2 API Guide

Post creates an integrator registration

post

{basePath}/notifications/registration

The API is used to register a subscriber.

The API creates a subscription to a resource for the current subscriber. POST request is used only when registering and doesn't provide the ability to update a registration details. Therefore, the use of PUT request is preferred.

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

200 Response

Creates an integrator

400 Response

400 Bad Request Also returned if integrator already exists.

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.