AI智能体的崛起：Arazzo如何定义API工作流的未来

arazzo: 1.0.1
info:
  title: BNPL Loan Application Workflow
  version: 1.0.0
  description: >
    This workflow walks through the steps to apply for a BNPL loan at checkout, including checking product eligibility, 
    retrieving terms and conditions, creating a customer record, initiating the loan transaction, customer authentication, 
    and retrieving the finalized payment plan. It concludes by updating the order status once the transaction is complete.
sourceDescriptions:
  - name: BnplEligibilityApi
    url: https://raw.githubusercontent.com/frankkilcommins/apidays-describing-api-workflows-with-arazzo/ef35e237576d7af2bc3be66d94ffca94eee5036d/specs/bnpl-eligibility.openapi.yaml
    type: openapi
  - name: BnplLoanApi
    url: https://raw.githubusercontent.com/frankkilcommins/apidays-describing-api-workflows-with-arazzo/ef35e237576d7af2bc3be66d94ffca94eee5036d/specs/bnpl-loan.openapi.yaml
    type: openapi
workflows:
  - workflowId: ApplyForLoanAtCheckout
    summary: Apply for a BNPL loan at checkout using the BNPL platform
    description: >
      This workflow describes the steps to secure a loan at checkout using a BNPL platform, involving multiple API calls 
      to check product eligibility, determine customer eligibility, initiate the loan transaction, authenticate the customer, 
      retrieve the payment plan, and update the order status.
    inputs:
      type: object
      required:
      - customer
      - products
      - totalAmount
      - token
      properties:
        customer:
          description: Customer details or link to an existing customer record.
          oneOf:
          - type: object
            required:
            - firstName
            - lastName
            - dateOfBirth
            - postalCode
            properties:
              firstName:
                type: string
              lastName:
                type: string
              dateOfBirth:
                type: string
                format: date-time
              postalCode:
                type: string
          - type: object
            required:
            - uri
            properties:
              uri:
                description: URI for an existing customer.
                type: string
                format: uri
        products:
          type: array
          minItems: 1
          items:
            type: object
            required:
            - productCode
            - purchaseAmount
            properties:
              productCode:
                type: string
              purchaseAmount:
                type: object
                required:
                  - currency
                  - amount
                properties:
                  currency:
                    type: string
                    pattern: "^[A-Z]{3}$"
                  amount:
                    type: number
        totalAmount:
          type: object
          required:
            - currency
            - amount
          properties:
            currency:
              type: string
              pattern: "^[A-Z]{3}$"
            amount:
              type: number
        token:
          description: Authorization token for the loan transaction.
          type: string
    steps:
      - stepId: checkProductEligibility
        description: Call the BNPL API to check if selected products are eligible for BNPL loans.
        operationId: $sourceDescriptions.BnplEligibilityApi.findEligibleProducts
        requestBody:
          contentType: application/json
          payload: |
            {
                "customer": "{$inputs.customer.uri}",
                "products": $inputs.products
            }
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          eligibilityCheckRequired: $response.body.eligibilityCheckRequired
          eligibleProducts: $response.body.productCodes
          totalLoanAmount: $response.body.totalAmount
        onSuccess:
          - name: productsEligible
            type: goto
            stepId: getCustomerTermsAndConditions
            criteria:
              - condition: $response.body.productCodes != null
          - name: productsNotEligible
            type: end
            criteria:
              - condition: $response.body.productCodes == null
      - stepId: getCustomerTermsAndConditions
        description: Retrieve terms and conditions for BNPL loans.
        operationId: $sourceDescriptions.BnplEligibilityApi.getTermsAndConditions
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          termsAndConditions: $response.body
        onSuccess:
          - name: eligibilityCheckRequired
            type: goto
            stepId: createCustomer
            criteria:
              - condition: $steps.checkProductEligibility.outputs.eligibilityCheckRequired == true
          - name: eligibilityCheckNotRequired
            type: goto
            stepId: initiateBnplTransaction
            criteria:
              - condition: $steps.checkProductEligibility.outputs.eligibilityCheckRequired == false
      - stepId: createCustomer
        description: >
          If the customer is not already enrolled, create a new customer record by verifying their eligibility for a BNPL loan.
        operationId: $sourceDescriptions.BnplEligibilityApi.createCustomer
        requestBody:
          contentType: application/json
          payload: |
            {
              "firstName": "{$inputs.customer.firstName}",
              "lastName": "{$inputs.customer.lastName}",
              "dateOfBirth": "{$inputs.customer.dateOfBirth}",
              "postalCode": "{$inputs.customer.postalCode}",
              "termsAndConditionsAccepted": true
            }
        successCriteria:
          - condition: $statusCode == 200 || $statusCode == 201
        outputs:
          customer: $response.body.links.self
        onSuccess:
          - name: customerCreated
            type: goto
            stepId: initiateBnplTransaction
            criteria:
              - condition: $statusCode == 201
          - name: customerNotEligible
            type: end
            criteria:
              - condition: $statusCode == 200
      - stepId: initiateBnplTransaction
        description: Initiate the BNPL loan transaction.
        operationId: $sourceDescriptions.BnplLoanApi.createBnplTransaction
        requestBody:
          contentType: application/json
          payload: |
            {
                "enrolledCustomer": "https://api.example.com/customers/12345",
                "products": $inputs.products,
                "totalAmount": $inputs.totalAmount
            }
        successCriteria:
          - condition: $statusCode == 202
        outputs:
          redirectAuthToken: $response.body.redirectAuthToken
          loanTransactionId: $response.body.loanTransactionId
        onSuccess:
          - name: authorizationRequired
            type: goto
            stepId: authenticateCustomerAndAuthorizeLoan
            criteria:
              - condition: $response.body.redirectAuthToken != null
          - name: authorizationNotRequired
            type: goto
            stepId: retrievePaymentPlan
            criteria:
              - condition: $response.body.redirectAuthToken == null
      - stepId: authenticateCustomerAndAuthorizeLoan
        description: Authenticate the customer and obtain authorization for the loan.
        operationId: $sourceDescriptions.BnplEligibilityApi.getAuthorization
        parameters:
          - name: authorizationToken
            in: query
            value: $inputs.token
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          redirectUrl: $response.headers.Location
      - stepId: retrievePaymentPlan
        description: Retrieve the finalized payment plan after loan authorization.
        operationId: $sourceDescriptions.BnplLoanApi.retrieveBnplLoanTransaction
        parameters:
          - name: loanTransactionId
            in: path
            value: $steps.initiateBnplTransaction.outputs.loanTransactionId
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          finalizedPaymentPlan: $response.body
      - stepId: updateOrderStatus
        description: Update the order status to "Completed" once the loan transaction is finalized.
        operationId: $sourceDescriptions.BnplLoanApi.updateBnplLoanTransactionStatus
        parameters:
          - name: loanTransactionId
            in: path
            value: $steps.initiateBnplTransaction.outputs.loanTransactionId
        requestBody:
          contentType: application/json
          payload: |
            { 
              "status": "Completed" 
            }
        successCriteria:
          - condition: $statusCode == 204
    outputs:
      finalizedPaymentPlan: $steps.retrievePaymentPlan.outputs.finalizedPaymentPlan