keyper.Backend.Admin.API (v1)
Download OpenAPI specification:Download
Get container ticket metadata
path Parameters
| operatorID required | integer <int64> |
| ticketID required | integer <int64> |
| containerID required | string |
| containerType required | string |
Responses
Response samples
- 200
- 409
Content type
application/json
{- "ticketMetadata": [
- {
- "namespace": "string",
- "key": "string",
- "description": "string",
- "value": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}Save container ticket metadata
path Parameters
| operatorID required | integer <int64> |
| ticketID required | integer <int64> |
| containerID required | string |
| containerType required | string |
Request Body schema:
required | Array of objects (SaveTicketMetadataItemDto) | ||||||||
Array
| |||||||||
Responses
Request samples
- Payload
Content type
{- "ticketMetadata": [
- {
- "namespace": "string",
- "key": "string",
- "description": "string",
- "value": "string"
}
]
}Response samples
- 200
- 409
Content type
application/json
{- "ticketMetadata": [
- {
- "namespace": "string",
- "key": "string",
- "description": "string",
- "value": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}get orders of member
path Parameters
| operatorID required | integer <int64> |
| memberID required | integer <int64> |
query Parameters
| return_orders_from_user | boolean |
| return_orders_to_user | boolean |
| country_code | string |
| from_date | string <date-time> |
| to_date | string <date-time> |
Responses
Response samples
- 200
- 409
Content type
application/json
[- {
- "organizer_id": 0,
- "organizer_name": "string",
- "event_id": 0,
- "event_name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "ticket_id": 0,
- "price": 0.1,
- "location_name": "string",
- "longitude": "string",
- "latitude": "string",
- "country_code": "string",
- "zip": "string",
- "city": "string",
- "street": "string"
}
]Get logging detail for a service
path Parameters
| operatorID required | integer <int64> |
| serviceName required | string |
query Parameters
| sinceDate | string <date-time> |
| month | integer <int32> |
| year | string |
| search | string |
| offset | integer <int32> |
| limit | integer <int32> |
Responses
Response samples
- 200
- 409
Content type
application/json
{- "loggingData": [
- {
- "service": "string",
- "message": "string",
- "level": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "totalNumber": 0
}Get logging counts per months for a service
path Parameters
| operatorID required | integer <int64> |
| serviceName required | string |
query Parameters
| search | string |
| fromYear | integer <int32> |
| tillYear | integer <int32> |
Responses
Response samples
- 200
- 409
Content type
application/json
{- "loggingCounts": [
- {
- "year": 0,
- "countPerMonth": [
- {
- "month": 0,
- "totalCount": 0
}
]
}
]
}Save custom metadata fields
path Parameters
| operatorID required | integer <int64> |
Request Body schema:
| namespace required | string [ 1 .. 50 ] characters |
| key required | string [ 1 .. 50 ] characters |
| description | string or null <= 256 characters |
Responses
Request samples
- Payload
Content type
{- "namespace": "string",
- "key": "string",
- "description": "string"
}Response samples
- 409
Content type
application/problem+json
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}Delete custom metadata fields
path Parameters
| operatorID required | integer <int64> |
| _namespace required | string |
| key required | string |
Responses
Response samples
- 409
Content type
application/problem+json
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}Response samples
- 200
- 409
Content type
application/json
{- "android": {
- "id": "string",
- "server_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "apple": {
- "id": "string",
- "auth_key_filename": "string",
- "auth_key_id": "string",
- "apple_team_id": "string",
- "bundle_identifier": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Save android push settings
path Parameters
| operatorID required | integer <int64> |
Request Body schema:
| server_key required | string non-empty |
Responses
Request samples
- Payload
Content type
{- "server_key": "string"
}Response samples
- 200
- 409
Content type
application/json
{- "id": "string",
- "server_key": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Save apple push settings
path Parameters
| operatorID required | integer <int64> |
Request Body schema:
| auth_key_id required | string non-empty |
| apple_team_id required | string non-empty |
| bundle_identifier required | string non-empty |
Responses
Request samples
- Payload
Content type
{- "auth_key_id": "string",
- "apple_team_id": "string",
- "bundle_identifier": "string"
}Response samples
- 200
- 409
Content type
application/json
{- "id": "string",
- "auth_key_filename": "string",
- "auth_key_id": "string",
- "apple_team_id": "string",
- "bundle_identifier": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Upload apple auth key
path Parameters
| operatorID required | integer <int64> |
Request Body schema: multipart/form-data
| ContentType | string |
| ContentDisposition | string |
object | |
| Length | integer <int64> |
| Name | string |
| FileName | string |
Responses
Response samples
- 201
- 409
Content type
application/json
{- "id": "string",
- "auth_key_filename": "string",
- "auth_key_id": "string",
- "apple_team_id": "string",
- "bundle_identifier": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 409
Content type
application/json
{- "walletSettingsId": 0,
- "isEnabled": true,
- "provider": "keyper",
- "platforms": [
- "unknown"
], - "containerTypes": [
- "NotSpecified"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Save wallet settings
path Parameters
| operatorID required | integer <int64> |
Request Body schema:
| isEnabled required | boolean |
| provider | string (WalletProviderEnum) Enum: "keyper" "ticketsystem" "skidata" |
| platforms required | Array of strings (WalletPlatformEnum) Items Enum: "unknown" "Apple" "Google" |
| containerTypes required | Array of strings (ContainerTypeEnum) Items Enum: "NotSpecified" "Ticket" "SeasonTicketGlobalBarcode" "SeasonTicketManyBarcodes" "CombinedTicket" |
Responses
Request samples
- Payload
Content type
{- "isEnabled": true,
- "provider": "keyper",
- "platforms": [
- "unknown"
], - "containerTypes": [
- "NotSpecified"
]
}Response samples
- 200
- 409
Content type
application/json
{- "walletSettingsId": 0,
- "isEnabled": true,
- "provider": "keyper",
- "platforms": [
- "unknown"
], - "containerTypes": [
- "NotSpecified"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Get apple wallet settings
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Responses
Response samples
- 200
- 409
Content type
application/json
{- "organizationName": "string",
- "appLaunchUrl": "string",
- "associatedStoreId": "string",
- "invalidatePasses": true,
- "nfcEnabled": true,
- "nfcPublicKey": "string",
- "appleTeamId": "string",
- "passTypeIdentifier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "certificate": {
- "fileName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}
}Save apple wallet settings
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Request Body schema:
| organizationName | string or null |
| appLaunchUrl | string or null |
| associatedStoreId | string or null |
| invalidatePasses | boolean |
| nfcEnabled | boolean |
| nfcPublicKey | string or null |
| appleTeamId | string or null |
| passTypeIdentifier | string or null |
| containerCypes | Array of strings or null (ContainerTypeEnum) Enum: "NotSpecified" "Ticket" "SeasonTicketGlobalBarcode" "SeasonTicketManyBarcodes" "CombinedTicket" |
Responses
Request samples
- Payload
Content type
{- "organizationName": "string",
- "appLaunchUrl": "string",
- "associatedStoreId": "string",
- "invalidatePasses": true,
- "nfcEnabled": true,
- "nfcPublicKey": "string",
- "appleTeamId": "string",
- "passTypeIdentifier": "string",
- "containerCypes": [
- "NotSpecified"
]
}Response samples
- 200
- 409
Content type
application/json
{- "organizationName": "string",
- "appLaunchUrl": "string",
- "associatedStoreId": "string",
- "invalidatePasses": true,
- "nfcEnabled": true,
- "nfcPublicKey": "string",
- "appleTeamId": "string",
- "passTypeIdentifier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "certificate": {
- "fileName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}
}Upload apple wallet certificate
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Request Body schema: multipart/form-data
| ContentType | string |
| ContentDisposition | string |
object | |
| Length | integer <int64> |
| Name | string |
| FileName | string |
| password | string |
Responses
Response samples
- 201
- 409
Content type
application/json
{- "organizationName": "string",
- "appLaunchUrl": "string",
- "associatedStoreId": "string",
- "invalidatePasses": true,
- "nfcEnabled": true,
- "nfcPublicKey": "string",
- "appleTeamId": "string",
- "passTypeIdentifier": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "certificate": {
- "fileName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}
}Get skidata settings
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Responses
Response samples
- 200
- 409
Content type
application/json
{- "url": "string",
- "username": "string",
- "password": "string",
- "nfcPublicKey": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Save skidata settings
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Request Body schema:
| url required | string [ 1 .. 2000 ] characters |
| username required | string [ 1 .. 1000 ] characters |
| password required | string [ 1 .. 1000 ] characters |
| nfcPublicKey | string or null <= 2000 characters |
Responses
Request samples
- Payload
Content type
{- "url": "string",
- "username": "string",
- "password": "string",
- "nfcPublicKey": "string"
}Response samples
- 200
- 409
Content type
application/json
{- "url": "string",
- "username": "string",
- "password": "string",
- "nfcPublicKey": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Save wallet setting skidata template
path Parameters
| walletSettingsID required | integer <int64> |
| operatorID required | string |
Request Body schema:
| ticketDefinition | string or null |
| isDefault | boolean |
| jsonTemplate | string or null |
Responses
Request samples
- Payload
Content type
{- "ticketDefinition": "string",
- "isDefault": true,
- "jsonTemplate": "string"
}Response samples
- 200
- 409
Content type
application/json
{- "ticketDefinition": "string",
- "isDefault": true,
- "jsonTemplate": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}