API-Tests mit Katalon und Salesforce

API-Tests mit Katalon und Salesforce sind ein kritischer Bestandteil, um die Zuverlässigkeit und Leistung von Salesforce-Anwendungen zu gewährleisten. Durch die Nutzung der umfassenden Testfähigkeiten von Katalon zusammen mit dem robusten API-Ökosystem von Salesforce können Teams leistungsstarke automatisierte Tests erstellen, die die Funktionalität und Sicherheit ihrer Salesforce-Integrationen und Workflows überprüfen.

Diese Einführung führt Sie durch die Einrichtung von API-Tests innerhalb von Salesforce und hebt die Bedeutung der Einbeziehung von API-Tests in Ihre Testdatenmanagementstrategie hervor. Das Verständnis, wie man APIs im Object Manager von Salesforce erstellt und verwaltet, ist der erste Schritt zu einem nahtlosen Testprozess. API-Tests spielen eine entscheidende Rolle bei der frühzeitigen Identifizierung von Diskrepanzen und Schwachstellen im Entwicklungszyklus und sind daher ein unverzichtbarer Bestandteil moderner Softwareentwicklungspraktiken.

Mit der richtigen Einrichtung können Teams ihre Testprozesse automatisieren, manuelle Fehler reduzieren und sicherstellen, dass ihre Salesforce-Anwendungen den höchsten Qualitäts- und Leistungsstandards entsprechen. Dieser Überblick zeigt, wie man API-Tests in Salesforce mit Katalon konfiguriert, und unterstreicht die Bedeutung der Integration dieser Tests mit dem Testdatenmanagement, um Effizienz und Wirksamkeit zu maximieren.

Arten von Salesforce APIs

  1. REST API
    Die REST API ist eine einfache, leichtgewichtige Option, die auf REST-Prinzipien basiert. Sie wird verwendet, um mit Salesforce-Daten mit Hilfe von standardisierten HTTP-Methoden (GET, POST, PATCH, DELETE) zu interagieren.
    Anwendungsfall: Abrufen von Datensätzen, Erstellen neuer Datensätze, Aktualisieren oder Löschen bestehender Datensätze.

  2. SOAP API
    Die SOAP API bietet ein komplexeres, XML-basiertes Protokoll, das ideal für die Integration mit älteren Systemen ist. SOAP wird verwendet, um in Echtzeit mit Salesforce-Objekten und -Daten zu arbeiten.
    Anwendungsfall: Integration mit Unternehmenssystemen, bei denen eine strikte XML-basierte Kommunikation erforderlich ist.

  3. Bulk API
    Die Bulk API ist optimiert für die asynchrone Verarbeitung großer Datenmengen. Sie ist nützlich für das Laden oder Löschen von Daten in großen Mengen.
    Anwendungsfall: Importieren oder Exportieren von Tausenden oder Millionen von Datensätzen.

  4. Streaming API
    Die Streaming API wird verwendet, um Echtzeit-Benachrichtigungen von Salesforce zu erhalten. Diese API ist ideal für Anwendungen, die Änderungen an Salesforce-Daten überwachen und entsprechend reagieren müssen.
    Anwendungsfall: Ereignisgesteuerte Architektur, Echtzeit-Dashboards.

  5. Metadata API
    Die Metadata API ermöglicht es Ihnen, Metadaten innerhalb von Salesforce abzurufen, bereitzustellen und zu verwalten (wie Apex-Klassen, benutzerdefinierte Objekte, Workflows usw.).
    Anwendungsfall: Migration von Konfigurationen zwischen Umgebungen.

Beispiel 1: Datenabruf mit Salesforce REST API

Um Daten von Salesforce mit der REST API abzurufen, verwenden Sie in der Regel eine GET-Anforderung. So können Sie Datensätze vom Salesforce Account-Objekt mit Katalon Studio abrufen:

Schritt 1: Einrichten der OAuth2-Authentifizierung

Bevor Sie eine Anforderung stellen, müssen Sie sich authentifizieren und ein Access-Token erhalten. Sobald Sie das Token haben:

Schritt 2: Datenabruf (GET-Anforderung)

  • Endpunkt: https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/{AccountId}

Beispiel:

GET https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/001D000000IqhSL
Authorization: Bearer {access_token}
  • Katalon Studio Einrichtung:
    1. Erstellen Sie eine neue RESTful-Anforderung in Katalon Studio.
    2. Stellen Sie die Methode auf GET ein.
    3. Fügen Sie in das Feld URL Ihren Salesforce-Endpunkt ein und ersetzen Sie {AccountId} durch eine tatsächliche Account-ID.
    4. Wählen Sie unter der Registerkarte Authorization die Option Bearer Token und fügen Sie das im Salesforce OAuth2-Prozess abgerufene Token ein.
    5. Führen Sie die Anforderung aus, und Sie sollten die Details des angegebenen Account erhalten.

Antwortbeispiel (JSON):

{
  "Id": "001D000000IqhSL",
  "Name": "Acme Corporation",
  "Phone": "1234567890",
  "Website": "http://www.acme.com",
  ...
}

Beispiel 2: Datenübermittlung mit Salesforce REST API

Um einen neuen Datensatz in Salesforce zu erstellen, verwenden Sie eine POST-Anforderung. Für dieses Beispiel erstellen wir einen neuen Account.

Schritt 1: Authentifizierung

Stellen Sie sicher, dass Sie Ihr Access-Token bereit haben, nachdem Sie den OAuth2-Fluss abgeschlossen haben.

Schritt 2: Datenübermittlung (POST-Anforderung)

  • Endpunkt: https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/

Beispiel:

POST https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "Name": "New Acme Corporation",
  "Phone": "9876543210",
  "Website": "http://www.newacme.com"
}
  • Katalon Studio Einrichtung:
    1. Erstellen Sie eine neue RESTful-Anforderung in Katalon Studio.
    2. Stellen Sie die Methode auf POST ein.
    3. Fügen Sie in das Feld URL Ihren Salesforce-Endpunkt ein.
    4. Wählen Sie unter der Registerkarte Authorization die Option Bearer Token und fügen Sie das im Salesforce OAuth2-Prozess abgerufene Token ein.
    5. Gehen Sie zum Abschnitt Body und wählen Sie Raw als Body-Typ. Fügen Sie dann die JSON-Struktur für den neuen Datensatz ein.
    6. Führen Sie die Anforderung aus, und Salesforce wird einen neuen Account-Datensatz erstellen.

Antwortbeispiel:

{
  "id": "001D000000IqhSL",
  "success": true,
  "errors": []
}

Beispiel 3: Datenaktualisierung mit Salesforce REST API

Um einen bestehenden Datensatz zu aktualisieren, verwenden Sie eine PATCH-Anforderung. Für dieses Beispiel aktualisieren wir die Telefonnummer eines bestehenden Account.

  • Endpunkt: https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/{AccountId}

Beispiel:

PATCH https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/001D000000IqhSL
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "Phone": "5551234567"
}
  • Katalon Studio Einrichtung:
    1. Stellen Sie die Methode auf PATCH in Ihrer RESTful-Anforderung ein.
    2. Aktualisieren Sie im Abschnitt Body die JSON-Struktur mit den Feldern, die Sie ändern möchten.
    3. Führen Sie die Anforderung aus, und Salesforce wird den Account aktualisieren.

Antwortbeispiel (Erfolg):

{
  "success": true,
  "errors": []
}

Beispiel 4: Datenlöschung mit Salesforce REST API

Um einen Datensatz zu löschen, verwenden Sie eine DELETE-Anforderung. Für dieses Beispiel löschen wir einen bestehenden Account.

  • Endpunkt: https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/{AccountId}

Beispiel:

DELETE https://yourInstance.salesforce.com/services/data/vXX.X/sobjects/Account/001D000000IqhSL
Authorization: Bearer {access_token}
  • Katalon Studio Einrichtung:
    1. Stellen Sie die Methode auf DELETE in Ihrer RESTful-Anforderung ein.
    2. Führen Sie die Anforderung aus, und der angegebene Account wird aus Salesforce gelöscht.

Antwortbeispiel (Kein Inhalt):

  • Eine erfolgreiche Löschung gibt keinen Inhalt zurück, was durch einen 204-Statuscode angezeigt wird.

Beispiel für Bulk API: Datenladung

Mit der Bulk API können Sie große Datenmengen asynchron laden. Lassen Sie uns 1.000 Datensätze in das Account-Objekt mit der Bulk API v2 laden.

  • Endpunkt: https://yourInstance.salesforce.com/services/data/vXX.X/jobs/ingest

Beispielanforderung (POST zur Erstellung eines Jobs):

POST https://yourInstance.salesforce.com/services/data/vXX.X/jobs/ingest
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "object": "Account",
  "contentType": "CSV",
  "operation": "insert"
}

Sobald der Job erstellt ist, können Sie die CSV-Datei mit den Datensätzen hochladen und den Fortschritt des Jobs überwachen.