SignNow REST API — Envelopes

naftiko: 1.0.0-alpha2
info:
  label: SignNow REST API — Envelopes
  description: 'SignNow REST API — Envelopes. 3 operations. Lead operation: List Envelopes. Self-contained Naftiko capability
    covering one Signnow business surface.'
  tags:
  - Signnow
  - Envelopes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SIGNNOW_API_KEY: SIGNNOW_API_KEY
capability:
  consumes:
  - type: http
    namespace: signnow-envelopes
    baseUri: https://api.signnow.com
    description: SignNow REST API — Envelopes business capability. Self-contained, no shared references.
    resources:
    - name: documentgroup
      path: /documentgroup
      operations:
      - name: listenvelopes
        method: GET
        description: List Envelopes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createenvelope
        method: POST
        description: Create Envelope
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documentgroup-group_id
      path: /documentgroup/{group_id}
      operations:
      - name: getenvelope
        method: GET
        description: Get Envelope
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: Unique envelope/document group identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.SIGNNOW_API_KEY}}'
  exposes:
  - type: rest
    namespace: signnow-envelopes-rest
    port: 8080
    description: REST adapter for SignNow REST API — Envelopes. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/documentgroup
      name: documentgroup
      description: REST surface for documentgroup.
      operations:
      - method: GET
        name: listenvelopes
        description: List Envelopes
        call: signnow-envelopes.listenvelopes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createenvelope
        description: Create Envelope
        call: signnow-envelopes.createenvelope
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documentgroup/{group-id}
      name: documentgroup-group-id
      description: REST surface for documentgroup-group_id.
      operations:
      - method: GET
        name: getenvelope
        description: Get Envelope
        call: signnow-envelopes.getenvelope
        with:
          group_id: rest.group_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: signnow-envelopes-mcp
    port: 9090
    transport: http
    description: MCP adapter for SignNow REST API — Envelopes. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-envelopes
      description: List Envelopes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signnow-envelopes.listenvelopes
      outputParameters:
      - type: object
        mapping: $.
    - name: create-envelope
      description: Create Envelope
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: signnow-envelopes.createenvelope
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-envelope
      description: Get Envelope
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signnow-envelopes.getenvelope
      with:
        group_id: tools.group_id
      outputParameters:
      - type: object
        mapping: $.