DokumentationCommerceHandbuch zu Commerce mit Cloud Infrastructure

Integrationen - Übersicht

Last update: Mon Dec 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Entwickler

Integrationen sind für die Verwendung externer Services nützlich, z. B. für Git-Hosting oder Slack-Bots, und für die Pflege Ihrer aktuellen Entwicklungsprozesse, z. B. die Verwendung der Pull-Request-Funktion für die Code-Überprüfung in GitHub. Sie können Ihrem Adobe Commerce on Cloud-Infrastrukturprojekt die folgenden Integrationen hinzufügen:

Integrationen

CLI

So fügen Sie eine Integration mithilfe der Cloud-CLI hinzu:

Der folgende Befehl beginnt mit interaktiven Eingabeaufforderungen, um den Typ und die Optionen für die neue Integration auszuwählen.

code language-bash 
magento-cloud integration:add

Auflisten der für Ihr Projekt konfigurierten Integrationen:

code language-bash 
magento-cloud integration:list

Beispielantwort:

code language-none 
+----------+--------------+---------------------------------------------------------------------------+
| ID       | Type         | Summary                                                                   |
+----------+--------------+---------------------------------------------------------------------------+
| <int-id> | bitbucket    | Repository: user/magento-int                                              |
|          |              | Hook URL:                                                                 |
|          |              | https://magento-url.cloud/api/projects/projectID/integrations/int-ID/hook |
| <int-id> | health.email | From: you@example.com                                                     |
|          |              | To: them@example.com                                                      |
+----------+--------------+---------------------------------------------------------------------------+
Konsole

So fügen Sie eine Integration mithilfe derCloud Console hinzu:

  1. Klicken in "" auf Integrations.

  2. Klicken Sie auf einen Integrationstyp oder klicken Sie auf Add integration.

  3. Führen Sie die Schritte zur Auswahl des Integrationstyps und zur Konfiguration schrittweise durch.

  4. Nach dem Hinzufügen der Integration wird sie in der Liste in der Ansicht Integrationen angezeigt.

Commerce-Webhooks

Sie können Commerce-Webhooks in Ihrem Cloud-Projekt mit der globalen ENABLE_WEBHOOKS“. Commerce-Webhooks senden als Reaktion auf Commerce-generierte Ereignisse Anfragen an einen externen Server. Im Webhooks-Handbuch wird diese Funktion ausführlich beschrieben.

Allgemeine Webhooks

Sie können Cloud-Infrastruktur- und Repository-Ereignisse mithilfe einer benutzerdefinierten Webhook-Integration erfassen und melden, um JSON-Nachrichten an eine Webhook-URL zu POST.

Verwenden Sie die folgende Syntax, um eine Webhook-URL hinzuzufügen:

magento-cloud integration:add --type=webhook --url=https://hook-url.example.com
  • type () - Geben Sie den Integrationstyp webhook an.
  • url - Geben Sie die Webhook-URL an, die JSON-Nachrichten empfangen kann.

Die Beispielantwort zeigt eine Reihe von Eingabeaufforderungen, die eine Möglichkeit bieten, die Integration anzupassen. Bei Verwendung der Standardantwort (leer) werden Nachrichten zu allen Ereignissen in allen Umgebungen in einem Projekt gesendet.

Sie können die Integration anpassen, um bestimmte Ereignisse“ zu melden z. B. Code an eine Verzweigung zu senden. Sie können beispielsweise das environment.push-Ereignis angeben, um eine Nachricht zu senden, wenn ein Benutzer Code an eine Verzweigung sendet:

Events to report (--events)
A list of events to report, e.g. environment.push
Default: *
Enter comma-separated values (or leave this blank)
>

Sie können Ereignisse in einem pending, in_progress oder complete Status melden:

States to report (--states)
A list of states to report, e.g. pending, in_progress, complete
Default: complete
Enter comma-separated values (or leave this blank)
>

Und Sie können Nachrichten ein oder ausschließen für bestimmte Umgebungen:

Included environments (--environments)
The environment IDs to include
Default: *
Enter comma-separated values (or leave this blank)
>

Excluded environments (--excluded-environments)
The environment IDs to exclude
Enter comma-separated values (or leave this blank)
>

Nach Abschluss der Integration erhalten Sie eine Zusammenfassung der Werte:

Created integration integration-ID (type: webhook)
+-----------------------+------------------------------+
| Property              | Value                        |
+-----------------------+------------------------------+
| id                    | integration-ID               |
| type                  | webhook                      |
| events                | - '*'                        |
| environments          | - '*'                        |
| excluded_environments | {  }                         |
| states                | - complete                   |
| url                   | https://hook-url.example.com |
+-----------------------+------------------------------+

Vorhandene Integration aktualisieren

Sie können eine vorhandene Integration aktualisieren. Ändern Sie beispielsweise den Status wie folgt von complete auf pending:

magento-cloud integration:update --states=pending <int-id>

Beispielantwort:

Integration integration-ID (webhook) updated
+-----------------------+------------------------------+
| Property              | Value                        |
+-----------------------+------------------------------+
| id                    | integration-ID               |
| type                  | webhook                      |
| events                | - '*'                        |
| environments          | - '*'                        |
| excluded_environments | {  }                         |
| states                | - pending                    |
| url                   | https://hook-url.example.com |
+-----------------------+------------------------------+

Zu meldende Ereignisse

Ereignis
Beschreibung
environment.access.add
Einem Benutzer wurde Zugriff auf die Umgebung gewährt
environment.access.remove
Ein Benutzer wurde aus der Umgebung entfernt
environment.activate
Eine Verzweigung wurde mit einer Umgebung „aktiviert“
environment.backup
Ein Benutzer hat einen Snapshot ausgelöst
environment.branch
Eine Verzweigung wurde mithilfe der Verwaltungskonsole erstellt
environment.deactivate
Eine Verzweigung wurde „deaktiviert“. Der Code ist noch vorhanden, aber die Umgebung wurde zerstört
environment.delete
Eine Verzweigung wurde gelöscht
environment.initialize
Die master Verzweigung des Projekts, die mit einem ersten Commit initialisiert wurde
environment.merge
Eine aktive Verzweigung wurde mithilfe der Verwaltungskonsole oder API zusammengeführt
environment.push
Ein Benutzer hat Code an eine Verzweigung gesendet
environment.restore
Ein Benutzer hat einen Schnappschuss wiederhergestellt
environment.route.create
Eine Route wurde über die Verwaltungskonsole erstellt
environment.route.delete
Eine Route wurde über die Verwaltungskonsole gelöscht
environment.route.update
Eine Route wurde über die Verwaltungskonsole geändert
environment.subscription.update
Die Größe der master wurde geändert, da sich das Abonnement geändert hat. Es gibt jedoch keine Inhaltsänderungen
environment.synchronize
In einer Umgebung wurden Daten oder Code aus der übergeordneten Umgebung kopiert
environment.update.http_access
HTTP-Zugriffsregeln für eine Umgebung wurden geändert
environment.update.restrict_robots
Die Funktion für blockübergreifende Roboter wurde aktiviert oder deaktiviert
environment.update.smtp
Das Senden von E-Mails wurde für eine Umgebung aktiviert oder deaktiviert
environment.variable.create
Eine Variable wurde erstellt
environment.variable.delete
Eine Variable wurde gelöscht
environment.variable.update
Eine Variable wurde geändert
project.domain.create
Eine Domain wurde erstellt und dem Projekt hinzugefügt
project.domain.delete
Eine dem Projekt zugeordnete Domain wurde entfernt
project.domain.update
Eine dem Projekt zugeordnete Domain wurde aktualisiert.
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26