Skip to main content

ZEP Interfaces

Learn how to connect ZEP to external systems via the REST and SOAP API.

Written by Benny Hahn

Through the ZEP Interfaces, ZEP exposes a REST and a SOAP API for integration with external systems. This allows master data, time bookings, projects, and additional content to be exchanged with ZEP programmatically.

Product line availability

Note: The ZEP Interfaces are available in ZEP Clock, ZEP Compact, and ZEP Professional.

The module is added as an optional module via the ZEP Self-Service Tool under Administration > Account.

Prerequisites

The following prerequisites are required to set up the ZEP Interfaces:

  • Licensed ZEP Interfaces module

  • Administrator rights in ZEP

  • Technical resources on the customer side: a developer or integration partner who connects the API

SOAP interface

The SOAP interface is ZEP's established web service interface and can be accessed via an XML-based request-response structure. It is often used for server-side integrations with existing backend systems.

Configuration is performed under Administration > Interfaces > SOAP interface. The following details are available there:

  • WSDL location – endpoint address for embedding the interface in the client

  • Authentication method – selectable between Digest, Basic, and Token

  • Login and secret – depending on the chosen authentication method

  • IP authentication – optional restriction to specific client IP addresses

  • Send employee access data automatically – controls whether new users automatically receive an email with access data

REST interface

The REST interface is the modern API based on HTTP/JSON. It is particularly suited for web and mobile applications as well as for connecting cloud services and is described in a machine-readable form via an OpenAPI specification.

Configuration is performed under Administration > Interfaces > REST interface. The following details are available there:

  • Base URL – endpoint address for all REST calls

  • Bearer token – token for authenticating each request

Typical use cases

The ZEP Interfaces can be used for a wide range of integration scenarios. Common use cases include:

  • Reporting and business intelligence – transferring project, time, and revenue data to external BI tools (e.g., Power BI, Tableau, Google Looker Studio)

  • HR system synchronization – automatic transfer of employee data from the leading HR system into ZEP

  • CRM integration – transfer of customer and project data from the CRM (e.g., Salesforce, HubSpot) into ZEP

  • Custom applications – building your own apps for time tracking, project overview, or approval workflows

  • Workflow automation – automatic creation or modification of bookings, projects, or absences triggered by external events

Documentation in Developer Hub

The complete endpoint reference, OpenAPI specification, technical examples, and an FAQ section on integration are available in the ZEP Developer Hub:

The Developer Hub is intended for developers and integration partners and is the authoritative technical reference for connecting to the ZEP Interfaces. A link to the Developer Hub is also available directly on the SOAP and REST interface settings pages in ZEP.

Did this answer your question?