API Consumers

Manage your ZAP POST API configuration and consumption

API consumers are used to connect our application to other applications. They may be required to connect one or more of our integrations or if you wish to build your own.

If you're a developer you can read the documentation here or visit the API

Accessing the page

In order to get to your API Consumers you should go to Settings in the top nav bar and then to 'API Consumers' in the sub navigation on the left side of the page

Adding a new API Consumer

In order to add a new consumer you should select the 'Add New Consumer' button.

ZAP~POST API Consumer Index page with Add New Consumer button highlighted

Once selected you will be to taken to the New Consumer slide out from which you can configure your preferred consumer name and enable the consumer. Whilst we will auto generate your API Credentials for you, these can be set manually to your preferred values or use the generate keys button to generate random keys.

Once you're happy with your values, you can click create consumer and the API consumer will be saved for you.

Managing Your API Consumers

Once you have one or more API consumers configured, you'll be able to see and manage them in the API Consumers UI. You can copy the API keys, enable or daisable them, delete them, generate a new set of keys and also view the API logs associated with the consumer

ZAP~POST API Consumers Index Page with records

API Logs

Each API Consumer will keep a log of all requests and responses for auditing and troubleshooting.

Once on the logs UI you can filter by date, API Verb, HTTP Status and endpoint.

By clicking the view logs icon you can see the request endpoint, the http status, request headers, request body, response headers and response body.