> 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/zapp/using-the-zapp/settings/api-consumers.md).

# API Consumers

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](https://apidocumentation.zappost.com/) or visit [the API](https://api.zappost.com/index.html)

## 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<br>

<figure><img src="/files/kwtrqvTwmrWYTshhFY0i" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/MA0qoMrKwv0RJaWmKMo8" 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="/files/N3NVdS9CxTydgUejatx9" alt=""><figcaption><p>ZAP-POST API Consumer Index page with Add New Consumer button highlighted</p></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="/files/uV586ePu0e234EXUEaDi" 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 daisable them, delete them, generate a new set of keys and also view the API logs associated with the consumer<br>

<figure><img src="/files/BHH7FyIEAxZaTRixIc9C" alt=""><figcaption><p>ZAP-POST API Consumers Index Page with records</p></figcaption></figure>

## API Logs

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

<figure><img src="/files/Muw3sHPS2xVtZCKqTtTF" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/OhxNvJMRdkzlJ8RSA9u4" 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.

<figure><img src="/files/CUGQ05u0aHaNPsSqrNN4" 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.