ezeep Blue API Documentation
Requirements
- ezeep Blue organization (sign up here) and its administrator account
- An ezeep Client ID (for first step use the demo Client ID) for your application and optionally Client Secret
- Redirect URI connected to your Client ID if using the Authorization Code Flow
To receive your Client ID, Client Secret and provide your redirect URI(s) please contact us via the API Contact Form.
Quickstart Guides
About the ezeep Blue APIs
The ezeep Blue APIs allow developers to integrate ezeep’s printing services into their own applications or systems. The APIs the ability to manage and automate printing processes, access print job status, history and reports, allow ezeep Hub remote administration and potentially even the administration of the printer itself.
When you interact with ezeep Blue Print APIs, you will send a request using a specific HTTP method and a designated endpoint. Depending on the specific operation, you may also include headers and parameters, such as path, query, or body parameters. In return, the API will provide a response, including a status code, headers and potentially a response body containing the requested information.
The ezeep Blue Print APIs reference documentation provides detailed information on the available operations, including the HTTP method, endpoint, and any necessary parameters. It also includes examples of requests and responses for each operation, allowing developers to easily understand how to properly format and handle the API’s responses. Developers can refer to the ezeep Blue API reference documentation for more information and guidance on using the API’s various features and functionality.
Authentication
Many operations in the ezeep Blue APIs also require authentication in order to access and make use of the available functionality. Authenticated requests will also potentially return additional information or allow for a higher rate of requests per hour. While some operations may be accessible without authentication, it is required to authenticate to ezeep ID server in order to access the functionality provided by the API. It is important to note that the authentication method and required credentials may vary depending on the specific API and its endpoints. Developers should refer to the ezeep Blue API documentation for more information on authentication and access requirements.
About Tokens
You can authenticate your request by adding a JWT token. For more information see Authorization
If you want to use the ezeep Blue APIs on behalf of an 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 allow to create new access tokens if required.
The ezeep Blue API operations used may require specific scopes or permissions, and it is important to check the API documentation for more information. Other operations may require different scopes or permissions.
For using the API on behalf of an organization or another user, ezeep may recommend using the ezeep Blue Login Tool. If an operation is available to the ezeep Blue CLI or ezeep Hub PowerShell module, the ezeep Blue API reference documentation for that operation will mention the same. The ezeep Blue API operations used may require specific permissions for ezeep Hub PowerShell module operations. Other operations may require different permissions. Developers should refer to the ezeep Blue API documentation for more information on authentication and access requirements.