API routes (Click a route to expand it, click here to expand/collapse all)
1. Supplier API
GET/schema/{schemaName}.json ⎘
Provides a json schema based on the name given
Parameter Location Type Requirements Optional Default value Description
schemaName URI-Path string
minLength: 3
maxLength: 32
pattern: ^([a-z-_.0-9]+|\*{1})$
 No Name of the schema
Response HTTP Type Description
Success 200 string result of the schema json
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
POST/supplier/submit ⎘Authentication required
Transfer any type of predefined message to KATE Innovations Inbound port. Simple authentication is performed using a supplier API-Key.
Parameter Location Type Requirements Optional Default value Description
payload POST-body string
minLength: 1
maxLength: 4194304
 No Message content
reference POST-body string
maxLength: 512
 Yes "" Message reference
targetCustomer POST-body string
minLength: 1
maxLength: 15
pattern: ^([a-zA-Z0-9-_]+|\*{1})$
 Yes "*" Customer ID of the target (receiver).
targetDepartment POST-body string
minLength: 1
maxLength: 15
pattern: ^([a-zA-Z0-9-_]+|\*{1})$
 Yes "*" Department ID of the target (receiver).
waitForProcessing POST-body int
enum: [ 0, 1 ]
 Yes 0 0/1-bool. If 0, a response is directly returned after validation and before processing and propagation. If 1, the response is returned once all processed messages are delivered to all consumers.
Response HTTP Type Description
Success 200 string If "waitForProcessing"=0, always returns a string "Validation passed." on success or one of the listed error codes otherwise. If "waitForProcessing"=1, always returns a string "Delivered: # out of #" on success or one of the listed error codes otherwise.
InvalidationException 400 Supplier specific invalidation. The message was rejected because it did not pass initial validation. See details for specifics.
InvalidTargetException 403 Specified target (customer + department) is invalid: it does not exist or you are not authorized (yet) to send to this target.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
SupplierAPIKeyAuth
Required flags:
None ⎘
2. Consumer API
GET/consumer/poll ⎘Authentication required
Retrieves any undelivered messages to the Consumer registered to the Consumer API-Key. Simple authentication is performed using a consumer API-Key.
Parameter Location Type Requirements Optional Default value Description
limit URI-Query int
minimum: 1
maximum: 100
 Yes 10 Maximum amount of messages to return.
Response HTTP Type Description
Success 200 ProcessedMessage[] Array of Processed Messages.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
ConsumerAPIKeyAuth
Required flags:
None ⎘
Default APIs
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Management API
GET/consumer/list ⎘Authentication required
Lists both active and deactivated consumers.
Response HTTP Type Description
Success 200 object Object with 2 keys "active" and "deleted", each containing an array of Consumers.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
GET/supplier/list ⎘Authentication required
Lists both active and deactivated suppliers.
Response HTTP Type Description
Success 200 object Object with 2 keys "active" and "deleted", each containing an array of Suppliers.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
POST/consumer/deactivateByName ⎘Authentication required
Deactivate a Consumer by provided exact name.
Parameter Location Type Requirements Optional Default value Description
name POST-body string No Exact name of the Consumer to deactivate
Response HTTP Type Description
Success 200 object Deactivated Consumer.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
POST/consumer/reactivateByName ⎘Authentication required
Reactivate a formerly deactivated Consumer by provided exact name.
Parameter Location Type Requirements Optional Default value Description
name POST-body string No Exact name of the deactivated Consumer to reactivate
Response HTTP Type Description
Success 200 object Reactivated Consumer.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
POST/mgmt/resumeProcessing ⎘Authentication required
Resumes any failed/aborted processing of inbound messages and/or undelivered processed messages. Could be invoked on periodical cron or after reboot.
Response HTTP Type Description
Success 200 object Object with 4 keys containing numeric counts: invalidated, processed, delivered, undelivered.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:admin ⎘
POST/supplier/deactivateByName ⎘Authentication required
Deactivate a Supplier by provided exact name.
Parameter Location Type Requirements Optional Default value Description
name POST-body string No Exact name of the Supplier to deactivate
Response HTTP Type Description
Success 200 object Deactivated Supplier.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('kate:admin' OR 'kate:devops') ⎘
POST/supplier/deleteDeactivatedByName ⎘Authentication required
Delete a deactivated Supplier by provided exact name.
Parameter Location Type Requirements Optional Default value Description
name POST-body string No Exact name of the deactivated Supplier to delete
Response HTTP Type Description
Success 200 true True.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('kate:admin' OR 'kate:devops') ⎘
POST/supplier/reactivateByName ⎘Authentication required
Reactivate a formerly deactivated Supplier by provided exact name.
Parameter Location Type Requirements Optional Default value Description
name POST-body string No Exact name of the deactivated Supplier to reactivate
Response HTTP Type Description
Success 200 object Reactivated Supplier.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('kate:admin' OR 'kate:devops') ⎘
Test API
POST/test/mapping ⎘Authentication required
Provide for the payload + the mapping and get the output as json format.
Parameter Location Type Requirements Optional Default value Description
payload POST-body string
format: json
 No The data to map with J2JMapper.
mapping POST-body string
format: json
 No The mapping to be used by the J2JMapper.
Response HTTP Type Description
Success 200 array The output of the mapping as json.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
Authentication schemes (Click an authentication scheme to expand it)
SupplierAPIKeyAuth
ConsumerAPIKeyAuth
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error