Sage Accounting API — Products

naftiko: 1.0.0-alpha2
info:
  label: Sage Accounting API — Products
  description: 'Sage Accounting API — Products. 4 operations. Lead operation: List Products. Self-contained Naftiko capability
    covering one Sage business surface.'
  tags:
  - Sage
  - Products
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAGE_API_KEY: SAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: accounting-products
    baseUri: https://api.accounting.sage.com/v3.1
    description: Sage Accounting API — Products business capability. Self-contained, no shared references.
    resources:
    - name: products
      path: /products
      operations:
      - name: listproducts
        method: GET
        description: List Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: search
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: items_per_page
          in: query
          type: integer
      - name: createproduct
        method: POST
        description: Create Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: products-key
      path: /products/{key}
      operations:
      - name: getproduct
        method: GET
        description: Get Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
      - name: updateproduct
        method: PUT
        description: Update Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SAGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: accounting-products-rest
    port: 8080
    description: REST adapter for Sage Accounting API — Products. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/products
      name: products
      description: REST surface for products.
      operations:
      - method: GET
        name: listproducts
        description: List Products
        call: accounting-products.listproducts
        with:
          search: rest.search
          page: rest.page
          items_per_page: rest.items_per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproduct
        description: Create Product
        call: accounting-products.createproduct
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/products/{key}
      name: products-key
      description: REST surface for products-key.
      operations:
      - method: GET
        name: getproduct
        description: Get Product
        call: accounting-products.getproduct
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateproduct
        description: Update Product
        call: accounting-products.updateproduct
        with:
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: accounting-products-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sage Accounting API — Products. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-products
      description: List Products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-products.listproducts
      with:
        search: tools.search
        page: tools.page
        items_per_page: tools.items_per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-product
      description: Create Product
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: accounting-products.createproduct
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-product
      description: Get Product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-products.getproduct
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-product
      description: Update Product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: accounting-products.updateproduct
      with:
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.