API-Schlüsselverwaltung

Erstellen, auflisten, rotieren und löschen Sie API-Schlüssel für Ihr Konto.

Authentifizierung

Alle Endpoints zur Schlüsselverwaltung erfordern eine Authentifizierung über einen vorhandenen API-Schlüssel. Verfügbar für alle Tarife.

Sicherheit: Vorgänge zur API-Schlüsselverwaltung sind sensibel. Führen Sie diese ausschließlich von serverseitigem Code aus, niemals von einer clientseitigen Anwendung.

API-Schlüssel auflisten

Rufen Sie alle mit Ihrem Konto verknüpften API-Schlüssel ab.


GET /api/v1/account/keys

Beispielanfrage

cURL


curl -X GET "https://api.sharpapi.io/api/v1/account/keys" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/keys',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
const { data } = await response.json();
 
for (const key of data) {
  console.log(`${key.name}: ${key.id_masked} (${key.is_active})`);
}

Python


import requests
 
response = requests.get(
    'https://api.sharpapi.io/api/v1/account/keys',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
keys = response.json()['data']
 
for key in keys:
    print(f"{key['name']}: {key['id_masked']} ({key['is_active']})")

Antwort (200)


{
  "data": [
    {
      "id": "key_abc123def456",
      "id_masked": "sharpapi_...f456",
      "name": "Production",
      "tier": "pro",
      "is_active": true,
      "created_at": "2025-10-15T08:30:00Z",
      "updated_at": "2026-02-08T14:22:10Z"
    },
    {
      "id": "key_xyz789ghi012",
      "id_masked": "sharpapi_...i012",
      "name": "Staging",
      "tier": "pro",
      "is_active": true,
      "created_at": "2026-01-05T12:00:00Z",
      "updated_at": "2026-02-07T09:15:30Z"
    }
  ],
  "meta": {
    "count": 2,
    "total": 2,
    "pagination": {
      "limit": 50,
      "offset": 0,
      "has_more": false,
      "next_offset": null
    },
    "updated_at": "2026-02-08T14:55:00Z"
  }
}

Felder des Key-Objekts

Feld	Typ	Beschreibung
`id`	string	Eindeutige Schlüsselkennung
`id_masked`	string	Maskierte Vorschau des Schlüssels (erste und letzte Zeichen sichtbar)
`name`	string \| null	Menschenlesbarer Schlüsselname
`tier`	string	Mit dem Schlüssel verknüpfter Abonnementtarif
`is_active`	boolean	Ob der Schlüssel derzeit aktiv ist
`created_at`	string	ISO 8601-Zeitstempel der Schlüsselerstellung
`updated_at`	string	ISO 8601-Zeitstempel der letzten Schlüsselaktualisierung

API-Schlüssel erstellen

Generieren Sie einen neuen API-Schlüssel für Ihr Konto.


POST /api/v1/account/keys

Anfragetext

Feld	Typ	Erforderlich	Beschreibung
`name`	string	Ja	Ein beschreibender Name für den Schlüssel (z. B. „Production”, „Mobile App”)

Beispielanfrage

cURL


curl -X POST "https://api.sharpapi.io/api/v1/account/keys" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Mobile App"}'

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/keys',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ name: 'Mobile App' })
  }
);
const { data } = await response.json();
console.log(`New key: ${data.key}`);
// IMPORTANT: Store this key securely. It will not be shown again.

Python


import requests
 
response = requests.post(
    'https://api.sharpapi.io/api/v1/account/keys',
    json={'name': 'Mobile App'},
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
new_key = response.json()['data']
print(f"New key: {new_key['key']}")
# IMPORTANT: Store this key securely. It will not be shown again.

Antwort (201)


{
  "data": {
    "id": "key_new345mno678",
    "key": "sharpapi_new345mno678pqr901stu234vwx567",
    "name": "Mobile App",
    "tier": "pro"
  }
}

Wichtig: Der vollständige key-Wert wird nur einmal zum Zeitpunkt der Erstellung zurückgegeben. Speichern Sie ihn umgehend sicher. Nachfolgende Anfragen zeigen nur die id_masked-Vorschau an.

API-Schlüssel löschen

Widerrufen und löschen Sie einen API-Schlüssel dauerhaft.


DELETE /api/v1/account/keys/{keyId}

Pfadparameter

Parameter	Typ	Beschreibung
`keyId`	string	Die `key_id` des zu löschenden Schlüssels

Beispielanfrage

cURL


curl -X DELETE "https://api.sharpapi.io/api/v1/account/keys/key_xyz789ghi012" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/keys/key_xyz789ghi012',
  {
    method: 'DELETE',
    headers: { 'X-API-Key': 'YOUR_API_KEY' }
  }
);
const result = await response.json();
console.log(`Deleted key: ${result.key_id}`);

Python


import requests
 
response = requests.delete(
    'https://api.sharpapi.io/api/v1/account/keys/key_xyz789ghi012',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
result = response.json()
print(f"Deleted key: {result['key_id']}")

Antwort (200)


{
  "deleted": true,
  "key_id": "key_xyz789ghi012",
  "message": "API key revoked successfully"
}

Diese Aktion ist nicht rückgängig zu machen. Jede Anwendung, die den gelöschten Schlüssel verwendet, verliert sofort den API-Zugriff. Sie können nicht den Schlüssel löschen, mit dem Sie sich gerade authentifizieren.

Fehlerantworten

404 Schlüssel nicht gefunden


{
  "error": {
    "code": "not_found",
    "message": "API key not found",
    "docs": "https://docs.sharpapi.io/en/api-reference/account-keys"
  }
}

400 Aktueller Schlüssel kann nicht gelöscht werden


{
  "error": {
    "code": "validation_error",
    "message": "Cannot delete the API key used to authenticate this request",
    "docs": "https://docs.sharpapi.io/en/api-reference/account-keys"
  }
}

API-Schlüssel rotieren

Generieren Sie einen neuen Schlüsselwert für einen vorhandenen API-Schlüssel. Der alte Schlüssel wird sofort widerrufen und durch einen neuen ersetzt.


POST /api/v1/account/keys/{keyId}/rotate

Pfadparameter

Parameter	Typ	Beschreibung
`keyId`	string	Die `key_id` des zu rotierenden Schlüssels

Beispielanfrage

cURL


curl -X POST "https://api.sharpapi.io/api/v1/account/keys/key_abc123def456/rotate" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/keys/key_abc123def456/rotate',
  {
    method: 'POST',
    headers: { 'X-API-Key': 'YOUR_API_KEY' }
  }
);
const { data } = await response.json();
console.log(`New key value: ${data.key}`);
// IMPORTANT: Update your application configuration with the new key immediately.

Python


import requests
 
response = requests.post(
    'https://api.sharpapi.io/api/v1/account/keys/key_abc123def456/rotate',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
rotated = response.json()['data']
print(f"New key: {rotated['key']}")
# IMPORTANT: Update your application configuration with the new key immediately.

Antwort (200)


{
  "data": {
    "key_id": "key_abc123def456",
    "name": "Production",
    "key": "sharpapi_rotated789abc012def345ghi678jkl",
    "key_preview": "sharpapi_...jkl",
    "status": "active",
    "rotated_at": "2026-02-08T15:10:00Z",
    "previous_key_revoked": true
  },
  "meta": {
    "updated_at": "2026-02-08T15:10:00Z"
  }
}

Sofortige Wirkung: Der vorherige Schlüsselwert wird in dem Moment widerrufen, in dem die Rotation abgeschlossen ist. Aktualisieren Sie Ihre Anwendungskonfiguration vor der nächsten API-Anfrage. Der neue key-Wert wird nur einmal angezeigt.

Tipp: Wenn Sie den Schlüssel rotieren, mit dem Sie sich gerade authentifizieren, wird die Rotation erfolgreich sein, aber Sie müssen den neuen Schlüssel für alle nachfolgenden Anfragen verwenden.

Antwort-Header

Alle Endpoints zur Schlüsselverwaltung geben standardmäßige Rate-Limit-Header zurück:


X-RateLimit-Limit: 300
X-RateLimit-Remaining: 294
X-RateLimit-Reset: 1707401400
X-Data-Delay: 0
X-Request-Id: req_keys123xyz

Best Practices

Verwenden Sie aussagekräftige Namen – Benennen Sie Schlüssel nach ihrem Zweck (z. B. „Production Server”, „Staging”, „Mobile App”), um sie später leicht identifizieren zu können
Regelmäßig rotieren – Rotieren Sie Schlüssel in regelmäßigen Abständen (z. B. alle 90 Tage) als bewährte Sicherheitspraxis
Verwenden Sie separate Schlüssel pro Umgebung – Erstellen Sie unterschiedliche Schlüssel für Produktion, Staging und Entwicklung
Überprüfen Sie inaktive Schlüssel – Identifizieren und bereinigen Sie nicht verwendete Schlüssel
Speichern Sie Schlüssel in einem Secrets-Manager – Verwenden Sie Umgebungsvariablen oder einen Secrets-Manager, hardcoden Sie Schlüssel niemals
Kompromittierte Schlüssel sofort widerrufen – Wenn ein Schlüssel offengelegt wird, löschen oder rotieren Sie ihn umgehend

API-Schlüsselverwaltung

Authentifizierung

API-Schlüssel auflisten

Beispielanfrage

cURL

JavaScript

Python

Antwort (200)

Felder des Key-Objekts

API-Schlüssel erstellen

Anfragetext

Beispielanfrage

cURL

JavaScript

Python

Antwort (201)

API-Schlüssel löschen

Pfadparameter

Beispielanfrage

cURL

JavaScript

Python

Antwort (200)

Fehlerantworten

API-Schlüssel rotieren

Pfadparameter

Beispielanfrage

cURL

JavaScript

Python

Antwort (200)

Antwort-Header

Best Practices

Verwandte Endpoints