Gérer
API et SDK TypeScript
Intégrez OpenShip dans vos propres outils via l'API et le SDK. Lisez les ressources, déployez des projets, inspectez l'état des opérations et gérez les flux de travail autorisés à partir du code.
Ouvrir le guideComment ça marche
Connectez un client à l'instance prévue avec un identifiant autorisé et un contexte d'espace de travail. La référence générée mappe les méthodes du SDK aux routes HTTP et explique les fonctionnalités requises et la disponibilité de la destination.
Utilisez les ID d’opération et les progrès documentés ou les interfaces de journalisation pour les travaux de longue durée. Les appels API et SDK utilisent les contrôles d'autorisation de la plateforme ; une requête tapée ne remplace pas l’accès aux ressources concernées.
Ce que tu peux faire
Clients typés
Utilisez le SDK TypeScript publié pour les opérations prises en charge.
Référence HTTP
Recherchez des formes de requête, des exigences d’autorisation et des exemples.
Visibilité des opérations
Suivez les travaux de longue durée via les interfaces de statut et de progression.
Mettez-le au travail.
Démarrez sur OpenShip Cloud ou déployez sur votre propre infrastructure.