API-Zugang — Proyex programmatisch nutzen

Geschrieben von Miro Flemke

Zuletzt aktualisiert Vor 23 Tagen

Was ist der API-Zugang?

Die Proyex REST-API ermöglicht es dir, Proyex-Daten programmatisch zu lesen und zu bearbeiten. Nutze die API fĂŒr eigene Integrationen, Automatisierungen oder um Proyex mit deinen bestehenden Tools zu verbinden.

Der API-Zugang ist ab dem Professional-Plan verfĂŒgbar.

Authentifizierung

Persönlicher API-Token

  1. Gehe zu Profil > API.

  2. Klicke auf Token erstellen.

  3. Gib dem Token einen Namen (z. B. "Meine Integration").

  4. Der Token wird einmalig angezeigt — kopiere ihn sofort, er kann nicht erneut eingesehen werden.

Verwende den Token als Bearer-Token in deinen API-Anfragen:

Authorization: Bearer dein-token

Token widerrufen

Du kannst einzelne Tokens jederzeit widerrufen. Der Token ist sofort ungĂŒltig und kann nicht wiederhergestellt werden.

VerfĂŒgbare Endpunkte

Die API bietet Zugriff auf alle wichtigen Bereiche von Proyex:

Projekte

Auflisten, erstellen, bearbeiten, löschen

Aufgaben

CRUD, Status Àndern, zuweisen, filtern

Unteraufgaben

Erstellen, bearbeiten, löschen

Meilensteine

Auflisten, erstellen, bearbeiten

ZeiteintrÀge

Timer starten/stoppen, manuell erstellen, Statistiken

CRM

Deals, Kontakte, Unternehmen, AktivitÀten, Pipelines

Benutzerdefinierte Felder

Felder und Werte verwalten

Dateien

Hochladen, auflisten, löschen

Notizen

Erstellen, bearbeiten, löschen

Chat

Konversationen und Nachrichten

Benachrichtigungen

Auflisten, als gelesen markieren

Webhooks

Abonnieren und verwalten

Revisionen

Auflisten und Versionsverlauf

API-Format

Alle Anfragen und Antworten verwenden JSON. Basis-URL:

https://app.proyex.io/api/v1/

Erfolgreiche Antwort

Bei erfolgreichen Anfragen erhÀltst du ein JSON-Objekt mit den angeforderten Daten und einer Erfolgsmeldung.

Fehler

Bei Fehlern erhÀltst du einen Statuscode (z. B. 400, 403, 404, 422) mit einer Fehlerbeschreibung.

Rate Limiting

Die API ist auf eine bestimmte Anzahl von Anfragen pro Minute begrenzt. Wenn du das Limit ĂŒberschreitest, erhĂ€ltst du eine Fehlermeldung (Status 429). Warte kurz und versuche es erneut.

Berechtigungen

API-Tokens haben die gleichen Berechtigungen wie der Nutzer, der sie erstellt hat. Du kannst nur auf Daten zugreifen, auf die du auch ĂŒber die Web-OberflĂ€che Zugriff hast.

HĂ€ufige Fragen

Kann ich mehrere Tokens erstellen?

Ja, du kannst beliebig viele Tokens erstellen — z. B. einen pro Integration oder pro Dienst.

Was passiert, wenn ich meinen Token verliere?

Du kannst den alten Token widerrufen und einen neuen erstellen. Der verlorene Token funktioniert danach nicht mehr.

Gibt es eine API-Dokumentation?

Ja, die API ist vollstÀndig dokumentiert. Die Dokumentation findest du unter deiner Proyex-URL im API-Bereich.

Tipps & Hinweise

  • Erstelle separate Tokens fĂŒr jede Integration — so kannst du einzelne Verbindungen widerrufen, ohne andere zu beeintrĂ€chtigen.

  • Nutze die API in Kombination mit Webhooks fĂŒr leistungsstarke Zwei-Wege-Integrationen.

  • Beachte das Rate Limiting bei automatisierten Anfragen und baue Wartezeiten ein.