Tilläggssjälvstudiekurs för leveransmetod

Gå till pipedream.com och registrera dig eller logga in.

Klicka på Nytt arbetsflöde (eller Lägg till arbetsflöde).

Välj HTTP/Webkrok för utlösaren.

I utlösarkonfigurationen anger du HTTP-svar till Returnera ett anpassat svar från ditt arbetsflöde. Detta gör att kodsteget kan skicka ett JSON-svar av typen.

Pipetream visar en unik HTTP-slutpunkts-URL, till exempel https://123456.m.pipedream.net.

Kopiera den här URL:en och använd den som tjänst-URL när du konfigurerar tillägget i Commerce Admin.

{width="600" modal="regular"}

Klicka på ikonen + för att lägga till ett steg.

Välj Kör Node.js-kod (kodsteg).

Ersätt standardkoden med följande JavaScript.

export default defineComponent({
async run({ steps, $ }) {
   const event = steps.trigger.event;
   const body = event.body ?? {};
   const headers = event.headers ?? {};
   const apiKey = headers["api-key"] ?? body.api_key ?? "";

   if (!apiKey || String(apiKey).trim() === "") {
      await $.respond({
      immediate: true,
      status: 401,
      headers: { "Content-Type": "application/json" },
      body: { error: "Missing or invalid API-Key header" },
      });
      return;
   }

   const shipment = body.shipment;
   if (!shipment || typeof shipment !== "object") {
      await $.respond({
      immediate: true,
      status: 400,
      headers: { "Content-Type": "application/json" },
      body: { error: "Missing or invalid shipment" },
      });
      return;
   }

   const rates = [
      {
      service_code: "mock_standard",
      service_name: "Mock Standard",
      carrier_friendly_name: "Mock Carrier",
      shipping_amount: { amount: 5.99 },
      shipment_cost: 5.99,
      cost: 5.99,
      },
      {
      service_code: "mock_express",
      service_name: "Mock Express",
      carrier_friendly_name: "Mock Carrier",
      shipping_amount: { amount: 12.99 },
      shipment_cost: 12.99,
      cost: 12.99,
      },
   ];

   await $.respond({
      immediate: true,
      status: 200,
      headers: { "Content-Type": "application/json" },
      body: { rates },
   });
},
});

Klicka på Distribuera.

{width="600" modal="regular"}

Navigera till MCP-inställningarna i kodningsagenten. Gå till exempel till Cursor > Settings > Cursor Settings > Tools & MCP i Markören. Kontrollera att verktygsuppsättningen commerce-extensibility är aktiverad utan fel. Om du ser fel kan du slå av och på verktygslådan.

{width="600" modal="regular"}

Om du har lagt till någon dokumentation i markörens kontext inaktiverar du den. Navigera till Markören > Inställningar > Markörinställningar > Indexering och dokument och ta bort all dokumentation som visas.

{width="600" modal="regular"}

Ge agenten åtkomst till API-specifikationen för modellfrekvenser, så att den kan implementera klienten korrekt. Om du inte redan har gjort det hämtar du API-specifikationsfilen för modellfrekvenser, öppnar den och lägger till filen .md i projektet (till exempel docs/mock-rates-api-spec.md) och refererar sedan till filen i uppmaningen.

Generera leveransmetodtillägg:

• Välj Planera-läge, om det är tillgängligt, i agentens chattfönster. Detta förhindrar agenten från att fortsätta utan någon plan.
• Ange följande uppmaning:

Build an Adobe Commerce extension that adds a shipping method at checkout. The rates come from an external mock shipping rates service: the merchant configures the service's URL and API key in Admin, and at checkout the extension asks that service for rates and shows the returned options to the customer.

External service (mock shipping rates API):
- The service endpoint URL is configurable by the merchant (for example https://123456.m.pipedream.net).
- The API is specified in ./docs/mock-rates-api-spec.md.

The merchant must be able to configure the following in the Adobe Commerce Admin UI. Use the Adobe Commerce Admin UI SDK (or equivalent App Builder extensibility options for the Admin) to add a configuration screen where the merchant can set:
- The service URL (where the extension sends rate requests).
- An API key the service expects (any non-empty value for the mock). The API key is sensitive data: it must be stored securely and must never appear in logs, error messages, or in the UI in full (e.g. mask in the UI).
- The warehouse (ship-from) address: name, phone, street, city, state, postal code, country. This is the origin used when requesting rates.

{width="600" modal="regular"}

Svara på agentens frågor så att den kan generera den bästa koden. Om agenten frågar vilket kit eller vilken mall som ska användas dirigerar du det till startpaketet för utcheckning med leveransdomänen och SDK-tillägget för administratörsgränssnittet så att både leveranswebbhoten och konfigurationsskärmen för handlare implementeras.

Agenten kan skapa en requirements.md-fil (eller motsvarande) som fungerar som källa för sanningen för implementeringen.

Granska filen requirements.md (eller motsvarande) och verifiera planen. Om allt ser korrekt ut instruerar du agenten att gå till arkitekturplanering (eller fas 2). Bekräfta att:

• En åtgärd för leveransmetoder (eller motsvarande) hanterar Commerce webkrok och anropar API:t för externa tariffer.
• En shipping-config-åtgärd (eller motsvarande) stöder GET (läskonfiguration, API-nyckelmaskerad) och SET (spara tjänst-URL, API-nyckel, lageradress) med config säkert lagrad, t.ex. i körningstillstånd.
• Administratörsgränssnittet innehåller en Mock Shipping-flik (eller liknande) med fält för Service URL, API-nyckel (lösenord/masked) och lageradress.

{width="600" modal="regular"}

Granska arkitekturplanen när agenten tillhandahåller den.

{width="600" modal="regular"}

Instruera agenten att fortsätta med kodgenerering. Agenten bör lägga till en modellbärare i transportföretagskonfigurationen så att Commerce kan acceptera de returnerade metoderna och använda webkrockmetoden plugin.magento.out_of_process_shipping_methods.api.shipping_rate_repository.get_rates (webkrotyp efter, som krävs Valfritt).

Agenten genererar den nödvändiga koden och ger en detaljerad sammanfattning med dina nästa steg (inklusive installation av beroenden, registrering av modellagringsoperatören, konfigurering av Commerce webkrok och driftsättning).

{width="600" modal="regular"} {width="600" modal="regular"}

När du har verifierat den genererade koden distribuerar du tillägget med följande uppmaning:

Deploy the app.

Agenten utför en beredskapsbedömning före distributionen (till exempel kontroll av .env för COMMERCE_WEBHOOKS_PUBLIC_KEY, COMMERCE_BASE_URL och OAuth/IMS-variabler om Admin-gränssnittet eller Commerce API används).

{width="600" modal="regular"}

När du är säker på utvärderingsresultaten instruerar du agenten att fortsätta med distributionen. Agenten använder MCP-verktygen för att verifiera, bygga och driftsätta automatiskt.

{width="600" modal="regular"}

Registrera modellföretaget i Commerce (kör en gång efter distributionen):

npm run create-shipping-carriers

Kontrollera att .env har COMMERCE_BASE_URL och en giltig OAuth/IMS-autentiseringsuppgift, så att skriptet kan registrera transportören.

Konfigurera leveranswebbkroken i Commerce Admin:

• Gå till Lager > Inställningar > Konfiguration > Adobe-tjänster > Commerce-webbböcker.

• Lägg till en webkrok:

  • Webkrok-metod: plugin.magento.out_of_process_shipping_methods.api.shipping_rate_repository.get_rates
  • Webkrotyp: efter
  • URL: den distribuerade webbåtgärds-URL:en shipping-methods (från distributionsutdata eller Adobe Developer Console).
  • Obligatoriskt: Valfritt - Det gör att utcheckning fortfarande fungerar om det externa API:t inte returnerar några frekvenser.

{width="600" modal="regular"}

Konfigurera Admin UI SDK-tillägget:

• I Commerce Admin går du till Store > Inställningar > Konfiguration.
• Öppna Adobe-tjänster > Admin UI SDK.
• Ange Aktivera administratörsgränssnittet för SDK till Ja och klicka på Spara konfiguration om det inte redan är aktiverat.
• Klicka på Konfigurera tillägg, välj den arbetsyta som appen är distribuerad till och klicka sedan på Använd. Du kan också välja alternativet Egen och ange namnet på arbetsytan.
• Välj din App Builder-app i listan och spara den. Om appen inte visas klickar du på Uppdatera registreringar och försöker igen.

{width="600" modal="regular"}

Konfigurera Mock Shipping-metoden i Adobe Commerce Admin-gränssnittet:

• Öppna Appar och välj din app.

• Öppna fliken Mock Shipping (eller motsvarande).

• Ange följande information:

  • Tjänst-URL: den Pipetream-arbetsflödes-URL som du kopierade (till exempel https://123456.m.pipedream.net).
  • API-nyckel: ett icke-tomt värde för modellen, till exempel tutorial-key.
  • Lagerställe (leveransadress): namn, telefon, gata, ort, postnummer, land.

• Klicka på Spara. Konfigurationen lagras i körningstillstånd och används av åtgärden för leveransmetoder.

{width="600" modal="regular"}

Verifiera vid utcheckning: Lägg till en produkt i kundvagnen, gå till utcheckningen och ange en leveransadress. Du bör se alternativen för leverans av modeller, till exempel Mock Standard och Mock Express.

{width="600" modal="regular"}