Print Service API 1.0.0

Allows you to interact with printers. Using it you can:

• Create a print job
• Receive events on the print job

Servers

Production

Production server.

Parameter	Value
URL	https://api.print.example.com
Protocol	AMQP 0-9-1

Security

Scheme	Scopes
OAuth 2	read:user write:user

Staging

Staging server.

Parameter	Value
URL	mqtt://staging.api.print.example.com:{port}
Protocol	MQTT v3.1.1

Server URL Variables

Variable	Allowed	Default	Description
port	1883 8883	1883	Secure connection (TLS) is available through port 8883. Examples: - mqtt://staging.api.print.example.com - mqtt://staging.api.print.example.com:1883 - mqtt://staging.api.print.example.com:8883

Security

Scheme	Scopes
API Key

Bindings

MQTT

Parameter	Value	Description
Client Id	guest	The client identifier.
Clean session	false	Whether to create a persistent connection or not.
Last Will and Testament topic	/last-wills	The topic where the Last Will and Testament message will be sent.
Last Will and Testament QoS	2	Defines how hard the broker/client will try to ensure that the Last Will and Testament message is received.
Retain Last Will and Testament message	false	Whether the broker should retain the Last Will and Testament message or not.
Keep-Alive	60	Interval in seconds of the longest period of time the broker and the client can endure without sending a message.
Binding Version	0.1.0	The version of this binding.

Channels

commands/{queueId}

The topic on which commands can be sent to a print queue.

Parameters

Parameter	Location	Description
queueId		The identifier of the print queue.

queueId

Name	Type	Format	Allowed	Default	Description
-	string

Messages

Operation	Message	Description
publish	createPrintJob	Creates a print job.
publish	cancelPrintJob	Cancels a print job.

As Publisher

Sends commands to a print queue.

Available commands:

• Create a print job
• Cancel a print job

Print Queue Commands Documentation.
https://www.example.com/docs/api/queues/commands

Operation Id: printQueueCommand

events/{jobId}

The queue on which print job events can be consumed.

Parameters

Parameter	Location	Description
jobId		The identifier of the print job.

jobId

Name	Type	Format	Allowed	Default	Description
-	string

Bindings

AMQP

Queue

Parameter	Value	Description
Name	events/jobs	The name of the queue.
Durable	true	Whether the queue should survive broker restarts or not.
Exclusive	false	Whether the queue should be used only by one connection or not.
AutoDelete	false	Whether the queue should be deleted when the last consumer unsubscribes.
Virtual Host	/	The virtual host of the queue.
Binding Version	0.1.0	The version of this binding.

Messages

Operation	Message	Description
subscribe	printJobEvent	Print job event.

As Subscriber

Consumes print job events.

Available events:

• Print job created
• Print job started
• Print job finished
• Print job canceled

Print Job Events Documentation.
https://www.example.com/docs/api/jobs/events

Operation Id: printJobEvent

Bindings

AMQP

Parameter	Value	Description
TTL	60	TTL (Time-To-Live) for the message.
User Id	guest	Identifies the user who has sent the message.
CC	user.log,support.log	The routing keys the message should be routed to at the time of publishing.
Priority	10	A priority for the message.
Delivery mode	2	Delivery mode of the message.
Mandatory	false	Whether the message is mandatory or not.
BCC	external.audit	Like CC but consumers will not receive this information.
Reply To	user.reply	Name of the queue where the consumer should send the response.
Timestamp	true	Whether the message should include a timestamp or not.
ACK	true	Whether the consumer should ack the message or not.
Binding Version	0.1.0	The version of this binding.

Tags

event

Print job event.
https://www.example.com/docs/api/jobs/events

queue

Print queue.
https://www.example.com/docs/api/queues

Messages

createPrintJob

Creates a print job.

Use this message to create a print job.

The job Id can be used to get the status of the job or cancel it.

Print Jobs Documentation.
https://www.example.com/docs/api/jobs

Payload

Content Type: application/json

Name	Type	Format	Allowed	Default	Description
jobId	string				Job Id.
userId	string				User Id.
documentName	string				Document name. deprecated
priority	string		low medium high		Priority. Print Job Priority Documentation. https://www.example.com/docs/api/jobs/priority

Headers

Name	Type	Format	Allowed	Default	Description
x-api-key	string				API Key.
x-correlation-id	string				Correlation ID.

Correlation ID

Location	Description
$message.header#/x-correlation-id	Identifier used for message tracing and correlation.

cancelPrintJob

Cancels a print job.

Payload

Content Type: application/json

Name	Type	Format	Allowed	Default	Description
jobId	string				Job Id. required
force	boolean			false	Force cancellation.

Headers

Name	Type	Format	Allowed	Default	Description
x-api-key	string				API Key.
x-correlation-id	string				Correlation ID.

Correlation ID

Location	Description
$message.header#/x-correlation-id	Identifier used for message tracing and correlation.

Bindings

AMQP

Parameter	Value	Description
Content Encoding	gzip	A MIME encoding for the message content.
Message Type	job.create	Application-specific message type.
Binding Version	0.1.0	The version of this binding.

Tags

job

Print job.
https://www.example.com/docs/api/jobs

printJobEvent

Print job event.

Payload

Content Type: application/json

Name	Type	Format	Allowed	Default	Description
jobId	string				Job Id.
status	string		created started finished canceled		Status.

Security

API Key

Provide your API key as the user and leave the password empty.

Parameter	Value
Security scheme	API Key
Location of the API key	user

OAuth 2

OAuth 2.0.

Parameter	Value
Security scheme	OAuth 2.0

OAuth Implicit Flow

Parameter	Value
Authorization URL	https://auth.example.com/oauth
Refresh URL	https://auth.example.com/oauth/refresh

Scopes

Scope	Description
read:job	Read print jobs.
write:job	Write print jobs.

Tags

asyncapi

The industry standard for defining asynchronous APIs.

AsyncAPI specification 2.0.0
https://www.asyncapi.com/docs/specifications/2.0.0

License

Apache 2.0
https://www.apache.org/licenses/LICENSE-2.0

Terms Of Service

http://www.example.com/terms

Contact

API Support
https://www.example.com/support
support@example.com