Skip to main content

keyper.API.Service (v1)

Download OpenAPI specification:Download

FacebookMessenger

FacebookMessenger_Get

query Parameters
hub.mode
string
hub.challenge
string
hub.verify_token
string

Responses

Response samples

Content type
{
  • "FacebookMessengerResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

FacebookMessenger_Post

Responses

Response samples

Content type
{
  • "FacebookMessengerResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Intercom

Intercom_Webhook

Request Body schema:
required
type
string
app_id
string
id
string
topic
string
object (IntercomWebhookData)

Responses

Request samples

Content type
{
  • "type": "string",
  • "app_id": "string",
  • "id": "string",
  • "topic": "string",
  • "data": {
    }
}

Response samples

Content type
{
  • "GlobalResult": {
    }
}

MandrillProblem

MandrillProblem_Post

path Parameters
guidKey
required
string
Request Body schema:
required
Array
key
string
value
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

MandrillProblem_Head

path Parameters
guidKey
required
string

Responses

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Payment

Payment_Post

path Parameters
webhookIdentifier
required
string

Responses

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

TimedResource

TimedResource_Resource

query Parameters
timedResource.operator_id
integer <int64>
timedResource.key
string

Responses

Response samples

Content type
{ }

TimedResource_Resource

Request Body schema:
required
operator_id
integer <int64>
resource
string
public
boolean
ttl_minutes
integer <int32>
byte_length
integer <int32>

Responses

Request samples

Content type
{
  • "operator_id": 0,
  • "resource": "string",
  • "public": true,
  • "ttl_minutes": 0,
  • "byte_length": 0
}

Response samples

Content type
{
  • "Result": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

URLShortener

URLShortener_Settings

query Parameters
urlShortenerSettingsInParameter.operator_id
integer <int64>
urlShortenerSettingsInParameter.short_url_domain
string
urlShortenerSettingsInParameter.ttl_minutes
integer <int32>
urlShortenerSettingsInParameter.byte_length
integer <int32>

Responses

Response samples

Content type
{
  • "operator_id": 0,
  • "short_url_domain": "string",
  • "ttl_minutes": 0,
  • "byte_length": 0
}

URLShortener_Settings

Request Body schema:
required
operator_id
integer <int64>
short_url_domain
string
ttl_minutes
integer <int32>
byte_length
integer <int32>

Responses

Request samples

Content type
{
  • "operator_id": 0,
  • "short_url_domain": "string",
  • "ttl_minutes": 0,
  • "byte_length": 0
}

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Wallet

Wallet_Device

path Parameters
version
required
string
deviceLibraryIdentifier
required
string
passTypeIdentifier
required
string
serialNumber
required
string
Request Body schema:
required
pushToken
string
pushServiceUrl
string
DeviceLibraryIdentifier
string
PassTypeID
string
SerialNumber
string

Responses

Request samples

Content type
{
  • "pushToken": "string",
  • "pushServiceUrl": "string",
  • "DeviceLibraryIdentifier": "string",
  • "PassTypeID": "string",
  • "SerialNumber": "string"
}

Response samples

Content type
{
  • "WalletRegisterDeviceResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Wallet_Device

path Parameters
version
required
string
deviceLibraryIdentifier
required
string
passTypeIdentifier
required
string
serialNumber
required
string

Responses

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Wallet_DevicePassWallet

path Parameters
version
required
string
deviceLibraryIdentifier
required
string
passTypeIdentifier
required
string
serialNumber
required
string
Request Body schema:
required
pushToken
string
pushServiceUrl
string
DeviceLibraryIdentifier
string
PassTypeID
string
SerialNumber
string

Responses

Request samples

Content type
{
  • "pushToken": "string",
  • "pushServiceUrl": "string",
  • "DeviceLibraryIdentifier": "string",
  • "PassTypeID": "string",
  • "SerialNumber": "string"
}

Response samples

Content type
{
  • "WalletRegisterDeviceResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Wallet_Passes

path Parameters
version
required
string
passTypeIdentifier
required
string
serialNumber
required
string

Responses

Response samples

Content type
{
  • "WalletPassDataResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}

Wallet_Log

path Parameters
version
required
string
Request Body schema:
required
logs
Array of strings

Responses

Request samples

Content type
{
  • "logs": [
    ]
}

Response samples

Content type
{
  • "SimpleResult": {
    },
  • "TIsTrustedApplication": true,
  • "TIsAuthorizedUser": true,
  • "TIsEmailUnique": true,
  • "TIsSuccessful": true,
  • "TIsTrustedService": true,
  • "TIsSecondFactorNeeded": true,
  • "TIsSecondFactorSetupCompleted": true,
  • "TAdminUserAuthorisationReturnEnum": 0,
  • "TWalletUserIsAuthorized": true,
  • "TMailingTemplateTypeEnum": 0,
  • "KeyperDatabaseSetting": {
    },
  • "TWebSMSSettings": {
    },
  • "TApplicationID": 0,
  • "TOperatorID": 0,
  • "TOrganizerID": 0,
  • "TMemberID": 0,
  • "TExternalID": "string",
  • "TCreatedFilePrefix": "string",
  • "TCreatedFileURL": "string",
  • "TCreatedFileType": 0,
  • "TAuthenticationToken": "00000000-0000-0000-0000-000000000000",
  • "TValidFrom": "2019-08-24T14:15:22Z",
  • "TValidTill": "2019-08-24T14:15:22Z",
  • "THttpMethod": 0,
  • "THttpMethodAction": "string",
  • "TTextMessageID": 0,
  • "TTextMessage": "string",
  • "VerificationCode": "string",
  • "EmailVerificationType": 0,
  • "SMSVerificationType": 0,
  • "IsTestEnvironment": true,
  • "TIsNew": true
}