These docs are for v1.0. Click to read the latest docs for v2.0.

There have been several endpoints added to the Views resource that allow for more flexibilty in managing the View.

Added

Views

Create a View

  • Views can now be created. Dynamic Views cannot be created at this time.

Update a View

  • View metadata, such as name, can now be updated. There are specific endpoints available to add/delete Zylo Users and Applications from the View.

Add Zylo User to a View

  • Zylo Users can now be added to Views. To get the ID for a Zylo User, check out the "Zylo Users" resource.

Delete Zylo User from a View

  • Zylo Users can now be deleted from a View. To get the ID for a Zylo User, check out the "Zylo Users" resource.

Add Application to a View

  • Applications can now be added to Views. To get the ID for an Application, check out the "Applications" resource.

Delete Application from a View

  • Applications can now be deleted from a View. To get the ID for an Application, check out the "Applications" resource.

There is now an option to create Usage Connect integrations programmatically. The details for creating this Usage Connect integration can be found in the Create Usage Connect documentation.

Added

Usage Connect

Create Usage Connect Integration

  • A new endpoint to create a Usage Connect integration. Follow the Create Usage Connect documentation for a step-by-step on how to create an integration.

Improved

Integrations

Get Integrations

Get Integrations by Id

  • There is now a mappings array that can be returned for usageconnect type integrations. This will show the mappings for the Usage Connect integration.

Changes to the GET query for contracts when filtering on application_id. This should now match the information about a contract when view the same record in app.

Fixed

Contracts

  • When trying to filter contracts on a specific application_id the query was not handling the relationship a contract has to contractLineItems if a contract originally did not include lines items but then was changed to have line items.

Small improvements to the query requirements for applicationUsers and the response from zybrary.

Improved

Application Users

  • The applicationId is no longer required for the GET request.
  • The application_data object is only returned when here is an applicationId filter.

Zybrary

  • The supplier_id is now returned on a Zybrary object response.
  • The "Get Zybrary" operation now requires one of the following query parameters: search, app_domain, id, app_name.

Three new endpoints have been added to manage Zylo Users in the Zylo application.

Zylo Users are users who have an account within Zylo and can log into the application.

Added

Zylo Users

Get Zylo Users

  • An endpoint to get "Zylo Users" from your Zylo instance.

Get Integration by Id

  • An endpoint to retrieve a single "Zylo User" by its id.

Create Zylo User

  • An endpoint to add a new "Zylo User" to your Zylo application.
  • Currently, only companies that have SAML enabled can add a new Zylo User programmatically.

Update Zylo User by Id

  • An endpoint to update a "Zylo User" by its id.
  • Important note, when updating the permissions of a Zylo User, the new permissions will overwrite the existing permissions.

Delete Zylo User by Id

  • An endpoint to delete a "Zylo User" by its id.

The Test Enterprise API now supports OAuth2 server-to-server authentication, enabling secure communication using the Client Credentials and JWT Bearer flows.

Added

The Zylo Enterprise API now supports OAuth2 authentication via Client Credentials and JWT Bearer flows.

Client Credentials

Use the Client Credentials flow for server-to-server authentication without user involvement. Learn how to implement it in our Client Credentials Guide.

JWT Bearer

For communication requiring assertion-based authentication, the JWT Bearer flow is now available. See the JWT Bearer Guide for details.

The Integration and Usage Connect resources were added to the Enterprise API. Users can now get a list of their integrations, usage connect import jobs, and upload data via Usage Connect.

Added

Integration

Get Integrations

  • An endpoint to get "Integrations" from your Zylo instance. This only includes the metadata for the Integrations (does not include user data, see "Application Users").

Get Integration by Id

  • An endpoint to retrieve a single "Integration" by its id. This only includes the metadata for the Integration (does not include user data, see "Application Users").

Usage Connect

Get Import Jobs

  • An endpoint to retrieve all "Usage Connect" import jobs for your Zylo instance.

Create an Import Job

  • An endpoint to retrieve the required credentials needed to upload application data via "Usage Connect".
  • For a detailed explanation on how this endpoint functions, check out the "Import App Data" guide.

Adds GET endpoints for Zylo Users, Views, and Zylo Users / Applications related to a View.

Added

Zylo Users

  • Handles GET requests to retrieve Zylo Users associated with a Zylo instance.

Views

  • Handles GET requests to retrieve all Views.
  • Handles retrieving individual Zylo Users associated to a View.
  • Handles retrieving individual Applications associated to a View.

Enhancements have been made to the Payments resource to make it easier to associate suppliers to their payments.

Improved

Payments

  • Two new fields, supplier_id and supplier_name have been added to the GET response.

There has been an update to the zylo_modified_at field which is on every resource.

Improved

The zylo_modified_at field will default to the zylo_created_at value if it is null.

This ensures that users can retrieve only new or updated resources by filtering with zylo_modified_at.