Optionale Projekt-API
Stellen Sie vereinbarte Anwendungsvorgänge bereit, wenn Sie sie brauchen
Prüfen Sie den API-Umfang für ein berechtigtes Projekt und unterscheiden Sie geplante Routen von bereits gebauten Endpunkten.
Behandeln Sie die API als klar definierte Projektoption
- Option prüfen
Prüfen Sie die Verfügbarkeit der API und das entsprechende Projektangebot.
- Routenumfang festlegen
Klären Sie, welche Geschäftsvorgänge die API bereitstellen soll.
- Routenkatalog einsehen
Sehen Sie Methode, Pfad und den geplanten oder aktiven Status jeder Route ein.
Ergänzen Sie eine API, wenn Ihr Projekt eine braucht
Die Projekt-API ist ein optionaler Teil des Angebots. Prüfen Sie Umfang und Bedingungen vor der Aktivierung, statt anzunehmen, dass jede Anwendung sie enthält.
Die API-Werkzeuge ordnen die vorgeschlagenen Routen nach Geschäftsbereich. Rückfragen helfen festzulegen, was jeder Vorgang tun soll, bevor er umgesetzt wird.
Unterscheiden Sie geplante Routen von funktionierenden Endpunkten
Zugang für ein anderes System vorbereiten. Ein Projekt kann eine andere Anwendung benötigen, die seine Geschäftsvorgänge nutzt. Prüfen Sie den optionalen API-Umfang und das Angebot, statt anzunehmen, dass jede Funktion automatisch bereitgestellt wird. Die vereinbarten Vorgänge legen fest, worauf die Integration zugreifen soll.
Routenkatalog einsehen. Der Katalog zeigt Methode, Pfad, Beschreibung und Status jeder Route. Er hilft, den vorgeschlagenen Umfang von als aktiv registrierten Endpunkten zu unterscheiden, und ist eine praktische Referenz, um die Vorbereitung der API zu verfolgen.
Die richtige Integrationsrichtung wählen. Die API eines anderen Anbieters zu nutzen und Ihre eigene Anwendung bereitzustellen sind unterschiedliche Bedürfnisse. Externe Verbindungen decken das Erste ab, die Projekt-API die vereinbarte Bereitstellung. Wählen Sie den Weg, der zum gewünschten geschäftlichen Austausch passt.
Unterscheiden Sie eine bereitgestellte API von einer externen Verbindung
Eine Projekt-API stellt die vereinbarten Vorgänge Ihrer Anwendung bereit. Eine externe Verbindung beschreibt, wie Ihre Anwendung einen anderen Dienst nutzt. Beide erfüllen unterschiedliche Bedürfnisse.
Nutzen Sie den Routenkatalog, um Methode, Pfad und den Status eines Endpunkts, geplant oder aktiv, einzusehen. Diese Darstellung aktiviert keine API für Ihr Projekt.
Bewerten Sie die API-Option anhand eines konkreten Bedarfs
Bestimmen Sie, wer die Daten des Projekts nutzen wird und welche Vorgänge diese Integration erfordert. Das hilft, einen optionalen API-Umfang von einer Verbindung zu einem bestehenden externen Dienst zu unterscheiden.
Sehen Sie bei einem berechtigten Projekt die geplanten Routen und ihren Baustatus ein. Bestätigen Sie den betreffenden Dienst und die Umgebung, bevor Sie einen Endpunkt für eine Integration als verfügbar betrachten.
Von einem optionalen Umfang zur geprüften Bereitstellung
Verfügbarkeit und Bedingungen prüfen. Prüfen Sie die API-Option im tatsächlichen Projektangebot. Entscheiden Sie vor der Aktivierung, ob die Anwendung diese Bereitstellung braucht.
Vorgänge klären. Prüfen Sie die vorgeschlagenen Geschäftsvorgänge und beantworten Sie Fragen zu ihrem erwarteten Verhalten. Verfolgen Sie die Vorbereitungs- und Baustatus.
Einsehen, was aktiv ist. Sehen Sie den Routenkatalog und die veröffentlichte Referenz eines aktivierten Projekts ein. Eine geplante Route ist kein funktionierender Endpunkt.
Legen Sie den Integrationsumfang fest, bevor Sie eine API ergänzen
Beschreiben Sie die Vorgänge, die ein anderes System benötigt, und prüfen Sie die Bedingungen der Option. Die API soll einem vereinbarten geschäftlichen Austausch dienen.
Fragen zur optionalen Projekt-API
Sie ist eine Option, deren Verfügbarkeit und Preis im tatsächlichen Angebot erscheinen. Eine Anwendung kann auch ohne ihre Aktivierung arbeiten. Diese Darstellung richtet keine API für Ihr Projekt ein und aktiviert keine.
Sie beschreibt einen beabsichtigten Vorgang, der noch nicht als aktiver Endpunkt registriert ist. Nutzen Sie den Status im Katalog und die tatsächlich veröffentlichte Referenz, bevor Sie eine Integration beginnen.
Die Ansichten der Projekt-API zeigen die bereitzustellenden Bereiche, Fragen, Infrastruktur und Baustatus. Erfüllen Sie die genannten Voraussetzungen und sehen Sie den daraus entstehenden Routenkatalog ein.
Nutzen Sie die API-Referenz des aktivierten Projekts und der betreffenden Umgebung. Leiten Sie keinen Endpunkt und kein Authentifizierungsbeispiel allein aus einer geplanten Route ab.
Sie beschreiben einen anderen Dienst, den Ihre Anwendung nutzt. Diese Integrationsrichtung unterscheidet sich davon, die Vorgänge Ihrer eigenen Anwendung über die Projekt-API bereitzustellen.