---
title: "API Management"
canonical: "https://kb.webcockpit.app/en/documentation/administrator/api-management"
updatedDate: 2026-09-30T00:00:00.000Z
description: "API configuration and access management documentation."
tags: ["administrator", "api-management", "Pro"]
---

import { Image } from "astro:assets";
import swaggerImg from "./images/api_documentation.png";
import apiTokenImg from "./images/image-1024x553-1.png";

## Description

### About Webcockpit Connect (REST-API)

Webcockpit REST-API enables programmatic access to restaurant data [(REST Wikipedia)](https://de.wikipedia.org/wiki/Representational_State_Transfer). 
Webcockpit APIs are maintained and further developed independently of the existing Webcockpit reports and apps. We implement new APIs on request.

<Availability
  title="Availability"
  subscriptionLabel="Subscription"
  subscription="Pro"
  scopeLabel="Scope"
  scope="All markets"
  limitationsLabel="Limitations"
  limitations="	Accesible only for users with the role “Organisation Administrator”"
/>

## Information

This chapter contains information about the available endpoints, how to create an API Key and how to call an endpoint.

### API Endpoints

Webcockpit REST-API follows the OpenAPI Specification – Version 3. All available API requests and their data models are documented on the page mentioned below.

<Image
  src={swaggerImg}
  alt=""
/>

Documentation: https://api.webcockpit.app/swagger/index.html

### Call API Endpoint

API endpoints can be tested e.g. with the programme Postman.

**Settings Header**

- Key: X-Api-Key
- Value: [API Key]

**Settings Body**

- Typ: raw / JSON

**Example**

```json
https://api.webcockpit.app/api/api/Default/getsalesperbusinessday
{
“StoreId”:”12345″,
“From”:”2020-08-29T00:00:00.000Z”,
“To”:”2020-08-31T00:00:00.000Z”,
“CountryCode”:”XY”
}
```

### Create and manage API Key

Navigation menu in the “Administrator” section.

<Image
  src={apiTokenImg}
  alt=""
/>


Use the “Add Token” button to create a new API key. Then assign the API endpoints for which the new key should have access.