Alle Funktionen

Verwalten

API & TypeScript SDK

Integrieren Sie OpenShip über die API und das SDK in Ihre eigenen Tools. Lesen Sie Ressourcen, stellen Sie Projekte bereit, überprüfen Sie den Betriebsstatus und verwalten Sie autorisierte Workflows über den Code.

Öffnen Sie die Anleitung

Wie es funktioniert

Verbinden Sie einen Client mit autorisierten Anmeldeinformationen und einem Arbeitsbereichskontext mit der vorgesehenen Instanz. Die generierte Referenz ordnet SDK-Methoden HTTP-Routen zu und erläutert erforderliche Funktionen und Zielverfügbarkeit.

Verwenden Sie Vorgangs-IDs und dokumentierte Fortschritts- oder Protokollschnittstellen für lang andauernde Arbeiten. API- und SDK-Aufrufe nutzen die Berechtigungsprüfungen der Plattform; Eine getippte Anfrage ist kein Ersatz für den Zugriff auf die betreffenden Ressourcen.

Was Sie tun können

  • Typisierte Kunden

    Verwenden Sie das veröffentlichte TypeScript SDK für unterstützte Vorgänge.

  • HTTP-Referenz

    Hier finden Sie Anforderungsformen, Berechtigungsanforderungen und Beispiele.

  • Sichtbarkeit des Betriebs

    Verfolgen Sie lang andauernde Arbeiten über Status- und Fortschrittsschnittstellen.

Setzen Sie es in die Tat um.

Beginnen Sie auf OpenShip Cloud oder stellen Sie es auf Ihrer eigenen Infrastruktur bereit.