ezeep API Documentation
Requirements
- ezeep organization (sign up here) and its administrator account
- An ezeep Client ID (for testing, use the sandbox client ID) for your application and optionally Client Secret
- Redirect URI connected to your Client ID if using the Authorization Code Flow or the Authorization Code Flow with PKCE
Organization administrators can create the Client ID, optional Client Secret and redirect URI(s) themselves via the Managing OAuth clients REST API or the MCP self-service prompt.
Quickstart Guides
About the ezeep APIs
The ezeep APIs let you integrate ezeep printing into your own applications or systems: manage and automate printing, read print job status, history and reports, and administer ezeep Hub remotely.
Where to start:
- Building an integration with an AI agent: use the ezeep MCP server.
- Building an application with end-user OAuth: start with the Authorization Code Flow with PKCE.
- Evaluating the API: get a refresh token for the sandbox client from the API Token Generator, without implementing OAuth.
Authentication
Most operations of the ezeep APIs require authentication with the ezeep ID server.
About Tokens
You can authenticate your request by adding a JWT token. For more information see Authorization
If you want to use the ezeep APIs on behalf of a user, you can create a user access token. If you want to use it on behalf of a device (i.e. printer), you need to create a device access token. Access Tokens have a very limited lifetime (about one hour), refresh tokens have a longer lifetime and can be used to create new access tokens.
Each API operation may require specific scopes or permissions; see the reference page of the operation.