Skip to content

Intermediate API endpoint that encapsulates/handles the authentication and request to the Zammad API (like a wrapper) and exposes a single, dedicated endpoint for POSTing the payloads.

License

OSL-3.0, AFL-3.0 licenses found

Licenses found

OSL-3.0
LICENSE.txt
AFL-3.0
LICENSE_AFL.txt
Notifications You must be signed in to change notification settings

orienteed/zammad-gateway

Repository files navigation

Zammad Gateway


Table of Contents


📢 What is Zammad Gateway?

Zammad Gateway is an excellent tool for those who want to integrate Zammad with external systems but don't have the knowledge or time to develop a custom integration.

It is an intermediate API that encapsulates/handles the authentication and requests to the Zammad Helpdesk API (like a wrapper) and exposes some endpoints to interact with them. The Gateway is a straightforward and effective way to integrate Zammad with third-party systems.

This software can be installed on a server and configured to listen for incoming requests from external systems. It then forwards those requests to Zammad using the Zammad Helpdesk API.


🛒 Supported Platforms


Magento


Stay tuned!


✅ Requirements

The requirements are:

To use Zammad Gateway you need to have a Zammad instance up and running. You can install it using the Zammad installation guide.

Docker and docker-compose are also required. If you don't have them installed, you can follow the Docker installation guide and the Docker Compose installation guide.


⚙️ Installation

To install Zammad Gateway you need to follow these steps:

  1. Clone the repository with:
git clone https://github.com/orienteed/zammad-gateway
  1. Copy the .env.example file to .env.
  2. Fill .env file with the required data.
  3. Run the following command to start the gateway:
docker-compose up -d --build
  1. Now your gateway is running, you can see an endpoints summary in http://localhost:8081/docs

🚀 You can test every request using our Postman collection, click here to download it 🚀

🙌🏼 How to contribute

To contribute to this project, you can do it in the following ways:

  • Reporting bugs.
  • Suggesting enhancements.
  • Opening pull requests.

If you want to know more, please contact us


Developed by

About

Intermediate API endpoint that encapsulates/handles the authentication and request to the Zammad API (like a wrapper) and exposes a single, dedicated endpoint for POSTing the payloads.

Resources

License

OSL-3.0, AFL-3.0 licenses found

Licenses found

OSL-3.0
LICENSE.txt
AFL-3.0
LICENSE_AFL.txt

Stars

Watchers

Forks

Packages

No packages published