Einführung
IhrProjekt ist eine API-first-Plattform für Projekt- und Aufgabenverwaltung. Diese Anleitung führt Sie durch die grundlegende Konfiguration und Ihren ersten API-Aufruf.
Tipp
Wenn Sie so schnell wie möglich loslegen möchten, springen Sie direkt zum Schnellstart. Diese Einführung erklärt das Konzept und die Architektur.
Installation
Installieren Sie die Client-Bibliothek mit Ihrem bevorzugten Package-Manager:
# npm
npm install @ihrprojekt/sdk
# yarn
yarn add @ihrprojekt/sdk
# pnpm
pnpm add @ihrprojekt/sdkAuthentifizierung
Alle API-Anfragen erfordern einen API-Schlüssel. Den Schlüssel finden Sie in den Einstellungen Ihres Projekts.
import { Client } from '@ihrprojekt/sdk'
const client = new Client({
apiKey: process.env.IHRPROJEKT_API_KEY,
baseUrl: 'https://api.ihrprojekt.de/v1',
})
// Verbindung prüfen
const me = await client.users.me()
console.log('Verbunden als:', me.name)Sicherheitshinweis
Fügen Sie niemals den API-Schlüssel direkt in den Quellcode ein. Verwenden Sie immer Umgebungsvariablen oder einen Secret-Manager.
API Reference: Benutzer
Vollständige Übersicht der Endpunkte für die Benutzerverwaltung.
/api/v1/usersGibt eine Liste aller Benutzer zurück/api/v1/usersErstellt einen neuen Benutzer/api/v1/users/:idGibt Benutzerdetails zurück/api/v1/users/:idAktualisiert einen Benutzer/api/v1/users/:idLöscht einen BenutzerBeispielantwort
Alle Antworten sind im JSON-Format und enthalten eine standardisierte Hülle.
{
"data": {
"id": "usr_abc123",
"name": "Jan Müller",
"email": "jan@example.de",
"role": "admin",
"createdAt": "2026-01-15T10:30:00Z"
},
"meta": {
"requestId": "req_xyz789"
}
}Fehlercodes
Die API verwendet Standard-HTTP-Statuscodes.
| Code | Name | Beschreibung |
|---|---|---|
400 | Bad Request | Ungültiges Anfrageformat |
401 | Unauthorized | API-Schlüssel fehlt oder ist ungültig |
404 | Not Found | Ressource existiert nicht |
429 | Too Many Requests | Rate-Limit überschritten |
500 | Internal Error | Serverseitiger Fehler |