> For the complete documentation index, see [llms.txt](https://userguide.zappost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://userguide.zappost.com/zap-post-web-app/zap-post-user-guide/zap-app/using-the-zapp/settings/api-consumers.md).

# API Consumers

Manage your ZAP POST API configuration and consumption

The API consumers page (found under 'Settings') is used to manage your API consumers. \
An API Consumer is 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.&#x20;

If you're a developer you can read the [documentation here](/zap-api/zap-post-api-documentation.md) or visit [the API](https://api.zappost.com/index.html)

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FObyPDh1obEZk6ClfNvGA%2Fimage.png?alt=media&amp;token=98b11ee7-4df5-46ff-924c-2376c4815687" alt=""><figcaption></figcaption></figure>

## Adding a new API Consumer

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

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FjEfyB2duvYaULWpizy8J%2Fimage.png?alt=media&amp;token=e5a639f9-59cd-46a4-95ff-e15a2818f503" alt=""><figcaption></figcaption></figure>

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.&#x20;

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

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2F2yz0YTle15xFPHPd7Ytm%2Fimage.png?alt=media&amp;token=11c940c0-fa5b-41ee-b442-f687992347b4" alt=""><figcaption></figcaption></figure>

## 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 disable them, delete them, generate a new set of keys and also view the API logs associated with the consumer<br>

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FSd1ADzoDCxYBw4XLYJsX%2Fimage.png?alt=media&amp;token=cf83d56a-25ad-4fb3-be5f-17759f4966ae" alt=""><figcaption></figcaption></figure>

## API Logs

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

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FTh8lQztlPJvgV3Om2zIE%2Fimage.png?alt=media&amp;token=54a95bf2-8d37-41c3-bfbf-051714aeebdd" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FZnstAlMtqmpGxJajZA3d%2Fimage.png?alt=media&amp;token=e2a422de-fad4-418b-8428-651835437557" alt=""><figcaption></figcaption></figure>

By clicking the view logs icon you can see the request endpoint, the http status,  request headers, request body, response headers and  response body. Each content section is downloadable and has a copy to clipboard option for convenience.&#x20;

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FUC1NBaaMgAHsc96V19U0%2Fimage.png?alt=media&amp;token=b2084a8d-4efe-4ba9-97af-e57f2d0dc462" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://userguide.zappost.com/zap-post-web-app/zap-post-user-guide/zap-app/using-the-zapp/settings/api-consumers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
