Referencia
Los ejemplos incluidos
Los ejemplos de la Pokédex y de pagos con PayPal en detalle, qué muestra cada workflow y qué necesitas para ejecutarlos.
Luvin trae dos ejemplos para que pruebes todo sin una API propia. La Pokédex corre contra una API pública y no necesita nada. Pagos con PayPal muestra autorización, piezas reutilizables y webhooks, y corre en simulación o contra el sandbox de PayPal. Ambos son colecciones de verdad: puedes cambiarlas y ejecutarlas otra vez.
Abrir un ejemplo
Sección titulada «Abrir un ejemplo»- En la pantalla de bienvenida, haz clic en Probar la Pokédex o en Probar pagos con PayPal. Ver los ejemplos lista ambos.
- Luvin abre el ejemplo como una colección de un workspace llamado Ejemplos, guardado dentro de Luvin, con su documentación en el panel de la derecha.
La Pokédex se abre en modo API real. PayPal se abre en Simulación, porque todavía no tiene credenciales. El tour guiado recorre ambos.
Pokédex
Sección titulada «Pokédex»La Pokédex usa la PokéAPI, una API pública de solo lectura. No necesita credenciales y permite llamadas desde el navegador, así que corre de verdad desde el primer minuto. El contrato pokeapi.openapi.yaml es una PokéAPI reducida con seis operaciones. El ambiente es local, con el servidor del contrato.
| Workflow | Qué muestra |
|---|---|
| Pokemon card | Cuatro pasos encadenados por sus outputs, criterios con JSONPath y una acción de fin en el 404. |
| Type explorer | Tres pasos: un tipo, su primer Pokémon y su especie. El input lista los valores que acepta. |
| Battle matchup | Un workflow que depende de otro (dependsOn). |
| Register sighting | Una llamada HTTP real mezclada con pasos send y receive de AsyncAPI. |
Pokemon card
Sección titulada «Pokemon card»Consulta un Pokémon, luego su especie, a qué es débil su tipo y qué hace su habilidad. Cada paso lee lo que devolvió el anterior.
- stepId: getPokemon operationId: $sourceDescriptions.pokeapi.getPokemon parameters: - name: idOrName in: path value: $inputs.pokemon successCriteria: - condition: $statusCode == 200 - context: $response.body condition: $.abilities[?(@.is_hidden == false)] type: jsonpath onFailure: - name: pokemonNotFound type: end criteria: - condition: $statusCode == 404 outputs: id: $response.body#/id mainType: $response.body#/types/0/type/nameEl segundo successCriteria usa JSONPath para comprobar que el Pokémon tiene una habilidad visible. Si el Pokémon no existe, onFailure termina el workflow sin drama. El paso siguiente toma $steps.getPokemon.outputs.mainType como parámetro de ruta.
Type explorer
Sección titulada «Type explorer»El input type solo acepta los nombres de los tipos de Pokémon:
inputs: type: object required: [type] properties: type: type: string enum: [normal, fire, water, grass, electric] example: fire(El archivo lista los dieciocho tipos.) El primer paso lee el tipo, y los dos siguientes usan el primer Pokémon que devuelve.
Battle matchup
Sección titulada «Battle matchup»No declara ningún input. Depende de Type explorer, que corre primero, y usa sus outputs:
- workflowId: battleMatchup dependsOn: [typeExplorer] steps: - stepId: getRivalType operationId: $sourceDescriptions.pokeapi.getType parameters: - name: idOrName in: path value: $workflows.typeExplorer.outputs.strongAgainstRegister sighting
Sección titulada «Register sighting»Mezcla una llamada real con dos eventos, simulados a partir de pokedex-events.asyncapi.yaml. Los eventos son ficticios y nunca salen de tu computador. El paso que espera usa un correlationId y un timeout en milisegundos:
- stepId: awaitConfirmation channelPath: '{$sourceDescriptions.pokedexEvents.url}#/channels/sightingConfirmed' action: receive correlationId: $inputs.correlationId timeout: 5000Cosas para probar
Sección titulada «Cosas para probar»- Abre Pokemon card y pulsa Ejecutar.
- En Inputs, cambia
pokemonporcharizard,150omewtwo. - En Casos, ejecuta los casos generados: camino feliz, inputs faltantes o inválidos y un caso por acción, como «el Pokémon no existe».
- En Diseño, arrastra otra operación del contrato al lienzo. El YAML se escribe solo.
La PokéAPI pide un uso razonable: no ejecutes los casos en un bucle.
Pagos con PayPal
Sección titulada «Pagos con PayPal»Este ejemplo usa una Orders API v2 de PayPal reducida, para el sandbox (api-m.sandbox.paypal.com), sus webhooks como AsyncAPI y OAuth 2.0 por API. El sandbox no mueve dinero real.
| Workflow | Qué muestra |
|---|---|
| Create order | Parámetros reutilizables (PayPal-Request-Id y Prefer) y acciones de fallo reutilizables para el 400 y el 401. |
| Capture order | Verifica que el pedido esté APPROVED, captura el pago y espera el webhook PAYMENT.CAPTURE.COMPLETED. |
| Order receipt | dependsOn: [createOrder], con el id del pedido que devolvió Create order. |
Piezas reutilizables
Sección titulada «Piezas reutilizables»El archivo declara parámetros y acciones una sola vez, en components, y los pasos apuntan a ellos:
components: parameters: requestId: name: PayPal-Request-Id in: header value: '{{$randomUUID}}' failureActions: notApproved: name: notApproved type: end criteria: - condition: $statusCode == 422parameters: - reference: $components.parameters.requestIdonFailure: - reference: $components.failureActions.invalidRequestSi el comprador no aprobó el pedido, PayPal responde 422 y Capture order termina ahí, mediante la acción notApproved.
Capture order y el webhook
Sección titulada «Capture order y el webhook»El último paso espera el evento que PayPal envía cuando la captura se completa:
- stepId: awaitCaptureEvent channelPath: '{$sourceDescriptions.paypalEvents.url}#/channels/captureCompleted' action: receive correlationId: $inputs.orderId timeout: 5000Los webhooks siempre se simulan. Luvin no recibe eventos de PayPal.
Order receipt
Sección titulada «Order receipt»- workflowId: orderReceipt dependsOn: [createOrder] steps: - stepId: receipt operationId: $sourceDescriptions.paypal.showOrderDetails parameters: - name: id in: path value: $workflows.createOrder.outputs.orderIdAutorización
Sección titulada «Autorización»PayPal pide un token OAuth 2.0 en cada llamada. No está dentro del Arazzo: se define por API en la pestaña Autorización de los workflows y se guarda en flow-auth.yaml:
apis: paypal: type: oauth2 grantType: client_credentials accessTokenUrl: https://api-m.sandbox.paypal.com/v1/oauth2/token clientId: '{{clientId}}' clientSecret: '{{clientSecret}}'Luvin pide el token, lo renueva y lo envía en cada request. Mira Autorización de un workflow y OAuth 2.0.
Simulación o sandbox
Sección titulada «Simulación o sandbox»| Simulación | Sandbox (API real) | |
|---|---|---|
| Credenciales | Ninguna. | Un Client ID y un Secret de una app del sandbox. |
| Qué responde | Los ejemplos del contrato, webhook incluido. | El sandbox de PayPal. El webhook sigue simulado. |
| Úsalo para | Ver funcionar los tres workflows. | Comprobar respuestas reales. |
En simulación no se ejecutan los casos de rechazo ni los de datos propios. Mira Simulación.
Para ejecutar contra el sandbox:
- Ve a developer.paypal.com/dashboard, Apps & Credentials, pestaña Sandbox, y crea una app. Es gratis.
- En Luvin, abre el selector Ambiente de la barra de ejecución y elige Configurar ambiente….
- En el ambiente Sandbox, pega el Client ID como la variable
clientIdy el Secret como el secretoclientSecret. El secreto queda cifrado en tu computador. - Cambia a API real y ejecuta Create order. El pedido queda
CREATED. - Para capturarlo, abre el
approveUrldel resultado con una cuenta de comprador del sandbox (Testing Tools, Sandbox Accounts) y aprueba el pago. - Ejecuta Capture order, con ese
orderIden Inputs.