Trennen Sie die Konfiguration vom Code
Halten Sie die API-Adresse und die Anmeldeinformationen außerhalb des Quellcodes. Verwenden Sie Serverumgebungsvariablen und veröffentlichen Sie niemals einen echten Schlüssel in einem Browser-Bundle. Diese Demo-Integration verwendet nur Beispieldaten.
Definieren Sie den Vertrag, bevor Sie eine Verbindung herstellen
Vereinbaren Sie mit dem API-Team Aufgabenfelder, mögliche Zustände und Fehlerformate. Ein gemeinsamer Vertrag reduziert Nacharbeit und vermeidet implizites Verhalten zwischen Dashboard und Service.
Planen Sie den Anforderungslebenszyklus
Legen Sie Zeitlimits für die Aufgabenerstellung und den Ergebnisabruf fest. Führen Sie für die asynchrone Verarbeitung eine Abfrage in definierten Intervallen mit einem Wiederholungslimit durch. Mit Ablauf der Frist muss der Antrag das Warten ausdrücklich beenden.
Behandeln Sie Fehler als Teil des Produkts
Ungültige Anmeldeinformationen, unzureichendes Guthaben und Ausfälle erfordern spezifische Reaktionen. Zeigen Sie nützliche Meldungen an und protokollieren Sie nur die für die Diagnose erforderlichen Informationen, ohne Anmeldeinformationen oder Lösungstoken.
Vor der Veröffentlichung überprüfen
Testen Sie Authentifizierungsfehler, Nutzungsbeschränkungen und unerwartete Antworten im Staging. Diese Dokumentation schlägt eine Endpunktorganisation vor; Der eigentliche Dienst wird verbunden, nachdem dieser Vertrag definiert wurde.
