API-Sandboxvirtualisierung – Schulung für Kund*innen

Was ist die Sandboxvirtualisierung?

Die API-Sandboxvirtualisierung ist ein Service, der das Verhalten einer Live-Sandboxinstanz simuliert. Unser Virtualisierungsservice bietet eine konsistente Erfahrung, bei der die Antwort, die Sie empfangen, vordefiniert ist und sich nicht immer nach den von Ihnen eingegebenen jeweiligen Eingabewerten richtet.

Ein Beispiel: Angenommen, Sie tätigen mehrere Aufrufe mit derselben Ratenanfrage und ändern bei jedem Test die Standorte für Absender*in und Empfänger*in. Die API gibt dieselbe vordefinierte Ratenantwort zurück, unabhängig von den Adressänderungen. Obwohl die Werte eventuell nicht übereinstimmen, simuliert die Struktur der Antwort dann das, was Sie in der Liveumgebung erhalten würden.

Da der Virtualisierungsservice nicht auf die Backend-Komponenten des Livesystems zugreift, ist Ihre Integrationsprüfung vor Backend-Abhängigkeiten geschützt, während Sie dennoch die entsprechende Antwort erhalten.

Warum ist die FedEx Sandbox virtualisiert?

In einem komplexen, verflochtenen System wie bei FedEx gibt es leider einige Fälle, in denen eine abhängige Ressource nicht verfügbar ist und sich dadurch die Systemverfügbarkeit verschlechtert. Solche Fälle können, auch wenn diese remote geschehen, Ihre API-Integrationstests beeinträchtigen. Der Umfang Ihrer Integrationstests kann außerdem durch andere Einschränkungen in Liveinstanzen beschränkt werden. Dazu gehören:

  • Versandkonto ohne die erforderlichen Berechtigungen, ein bestimmtes Szenario zu testen
  • Begrenzte Verfügbarkeit von Testdaten
  • Geplante oder ungeplante Ausfallzeiten des Systems

Wie können Sie die Virtualisierungssandboxinstanz nutzen?

  • Lesen Sie die API-Dokumentation und machen Sie sich mit Endpunkten und Authentifizierungsmethoden vertraut. Dies hilft Ihnen beim Konzipieren effektiver Tests.
  • Laden Sie aus der API-Dokumentation die JSON API-Sammlung herunter und machen Sie sich damit vertraut.
  • Wählen Sie Beispieltransaktionen aus, die Ihren Nutzungsszenarien entsprechen, und testen Sie diese. Um eine konsistente Erfahrung zu gewährleisten, wird empfohlen, die Nutzlaststruktur der Anfrage nicht zu ändern, damit Sie die Virtualisierungsantwort erhalten.
  • Beachten Sie, dass nicht alle Eingabewerte die Antwort beeinflussen. Konzentrieren Sie sich stattdessen darauf, wie Ihre Anwendung mit den konsistenten Antworten umgeht.
  • Testen Sie, ob sich alle APIs gemäß der Dokumentation ordnungsgemäß verhalten. Schließen Sie sowohl positive wie auch negative Testfälle ein.
  • Versuchen Sie anhand der bereitgestellten negativen Testfälle nachzuvollziehen, wie Fehlermeldungen und Statuscodes zurückgegeben werden. Sie können dadurch herausfinden, wie Ihre Anwendung mit Fehlern umgehen soll. Informieren Sie sich in der JSON API-Sammlung und den Testfällen mit dem Präfix „Negativ“.

Vorteile der Virtualisierung

  • Geringere Wahrscheinlichkeit der Nichtverfügbarkeit von Ressourcen
  • Weniger Abhängigkeit von Testdaten
  • Schnellere Reaktion im Vergleich zur Livesandboxinstanz
  • Kein expliziter Zugriff auf Kontoebene für spezielle Services erforderlich.
  • Leichtere Tests und Zertifizierungen dank nahtloser Integration.

FAQ

  1. Wie kann ich mit der Anfrage auf die Virtualisierungsantwort zugreifen?
    In jeder API-Dokumentation wird die JSON API-Sammlung bereitgestellt. Öffnen Sie im API-Katalog die Dokumentation für die API. Suchen Sie in der API-Dokumentation nach dem Abschnitt „JSON API-Sammlung“. Diese JSON API-Sammlung hat alle Anfragen gespeichert, die die Virtualisierungsantwort erhalten würden.
  2. Benötige ich ein Token, um auf die Virtualisierungssandboxinstanz zuzugreifen?
    Ja. Die Tokengenerierung und Autorisierung funktionieren wie gehabt. Sie müssen das Token bei jeder Transaktion mit dem Virtualisierungssandboxservice übergeben.
  3. Woran kann ich erkennen, ob die Antwort vom Virtualisierungsservice kommt?
    Bei der virtualisierten Antwort wird die nachfolgende Warnung als Teil der Nutzlast hinzugefügt.

  4. Warum wird meine Adresse in der Raten- und Laufzeiten-API in der Anfragenutzlast nicht validiert?
    Die Adressvalidierung ist nicht Teil der Logik, die eine virtualisierte Ratenantwort beinhaltet. Es wird lediglich das Land validiert, sodass Sie jeden beliebigen Wert in die übrigen Adressfelder eingeben können.
  5. Stehen alle APIs in der Virtualisierungsumgebung zur Verfügung?
    Bisher wurden nur die folgenden APIs virtualisiert. An der Virtualisierung der restlichen APIs arbeiten wir.
Raten- und Laufzeiten-API Virtualisiert
Sendungsverfolgungs-API Virtualisiert
Freight LTL-API – Raten- und Abholfunktion Virtualisiert
Adressprüfungs-API Virtualisiert
Postleitzahlprüfungs-API Virtualisiert
Abholanfrage-API Virtualisiert
Serviceverfügbarkeits-API Virtualisiert
API für globalen Handel Virtualisiert
Ground Tagesabschluss-API Virtualisiert
API für offene Sendungen Virtualisiert
Versand-API Virtualisiert
API für die FedEx Stationssuche Virtualisiert