Zum Hauptinhalt springen

Authentifizierung

Die docs101-API verwendet API-Key-Authentifizierung. Fügen Sie Ihren API-Key im X-API-Key-Header bei jeder Anfrage hinzu.

API-Key-Format​

API-Keys folgen dem Format ak_live_ gefolgt von 32 hexadezimalen Zeichen:

ak_live_a1b2c3d4e5f6789012345678abcdef01

Authentifizierte Anfragen senden​

curl​

curl -H "X-API-Key: ak_live_IHR_KEY_HIER" \
  https://docs101.com/api/customers/

Um eine Ressource zu erstellen, senden Sie JSON im Request-Body:

curl -X POST \
  -H "X-API-Key: ak_live_IHR_KEY_HIER" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "email": "billing@acme.com"}' \
  https://docs101.com/api/customers/

Python​

import requests

API_KEY = "ak_live_IHR_KEY_HIER"
BASE_URL = "https://docs101.com/api"

headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json",
}

# Alle Kunden abrufen
response = requests.get(f"{BASE_URL}/customers/", headers=headers)
customers = response.json()

for customer in customers:
    print(customer["name"])

Eine Rechnung erstellen​

# Rechnung für einen Kunden erstellen
invoice_data = {
    "customer_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "invoice_date": "2026-03-05",
    "positions": [
        {
            "description": "Beratungsleistungen",
            "quantity": 10,
            "unit_price": 150.00,
            "vat_rate": 19.0
        }
    ]
}

response = requests.post(
    f"{BASE_URL}/invoices/",
    headers=headers,
    json=invoice_data,
)
print(response.json())

JavaScript (Node.js)​

const API_KEY = "ak_live_IHR_KEY_HIER";
const BASE_URL = "https://docs101.com/api";

// Alle Kunden abrufen
const response = await fetch(`${BASE_URL}/customers/`, {
  headers: {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json",
  },
});

const customers = await response.json();
console.log(customers);

PHP​

$apiKey = "ak_live_IHR_KEY_HIER";
$baseUrl = "https://docs101.com/api";

$ch = curl_init("$baseUrl/customers/");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-API-Key: $apiKey",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$customers = json_decode($response, true);

curl_close($ch);

API-Keys verwalten​

Sie verwalten API-Keys in der docs101-Web-App unter Kontoeinstellungen (Zahnrad-Symbol oben rechts) > API Keys:

  • Erstellen: Generieren Sie einen neuen Key mit einem beschreibenden Namen (bis zu 10 Keys pro Unternehmen)
  • Anzeigen: Sehen Sie alle Keys mit Name, Präfix, Erstellungsdatum und letzter Nutzung
  • Widerrufen: Deaktivieren Sie einen Key sofort — alle Anfragen mit diesem Key erhalten dann 401
Key-Sicherheit

Behandeln Sie Ihren API-Key wie ein Passwort. Committen Sie ihn nicht in die Versionskontrolle und teilen Sie ihn nicht in öffentlichen Kanälen. Verwenden Sie Umgebungsvariablen oder einen Secrets-Manager, um Keys in Ihren Anwendungen zu speichern.

Key-Lebenszyklus​

  • API-Keys sind an Ihr Unternehmenskonto gebunden
  • Keys laufen nicht ab, können aber jederzeit widerrufen werden
  • Wenn Sie vom Pro Plan downgraden, werden alle API-Keys automatisch deaktiviert
  • Ein erneutes Upgrade auf Pro reaktiviert zuvor deaktivierte Keys nicht — erstellen Sie stattdessen neue

API-Referenz​

Für die vollständige Liste der Endpunkte, Request/Response-Schemas und interaktives Testen siehe die Swagger-Dokumentation.