# IF.BUS + IF.API Developer KB

Generated: 2026-01-07T16:57:08Z

This document is build-time generated from registry data, schema scaffolds, and the KB config file. It is static and does not fetch data at runtime.

## Sources

- registry: /root/if.registry.json
- config: /root/docs/data/if_bus_api_kb.json
- schema: schemas/if-bus/carrier.schema.json
- schema: schemas/if-bus/carrier_manifest.schema.json
- schema: schemas/if-api/adapter.schema.json
- schema: schemas/if-api/adapter_spec.schema.json

## Product summary (registry-driven)

### if.bus
- product_id: if.bus
- path: /if/bus
- status: roadmap

### if.api
- product_id: if.api
- path: /if/api
- status: roadmap

## Concept graph (derived from schema x_if)

```mermaid
flowchart TD
  if_api_adapter["if.api.adapter"]
  if_api_adapter_spec["if.api.adapter_spec"]
  if_bus_carrier["if.bus.carrier"]
  if_bus_carrier_manifest["if.bus.carrier_manifest"]
  if_api_adapter -.-> if_api_adapter_spec
  if_api_adapter_spec --> if_api_adapter
  if_api_adapter_spec --> if_bus_carrier_manifest
  if_bus_carrier -.-> if_api_adapter_spec
  if_bus_carrier -.-> if_bus_carrier_manifest
  if_bus_carrier_manifest --> if_bus_carrier
  if_bus_carrier_manifest -.-> if_api_adapter_spec
```

## Schemas (fields + examples)

### IF.BUS Carrier
- schema_path: schemas/if-bus/carrier.schema.json
- product_id: if.bus
- concept_id: if.bus.carrier

Fields:
- `carrier_id` (string): Stable carrier identifier.
- `label` (string): Human-readable carrier label.
- `provider` (string): Source vendor or platform providing the carrier.
- `summary` (string): One-sentence description of what the carrier enables.
- `status` (string): Carrier readiness status.
- `category` (string): Carrier family.
- `capabilities` (array): Key capabilities exposed by the carrier.
- `docs_url` (string): Public documentation link for the carrier.
- `demo_share_id` (string): Optional public demo shareId (if available).

Example:
```json
{
  "capabilities": [
    "send",
    "status",
    "audit_log"
  ],
  "carrier_id": "docusign",
  "category": "connector",
  "demo_share_id": "HmlXcqae8heBq1siMrIRyw",
  "docs_url": "https://developers.docusign.com/",
  "label": "DocuSign",
  "provider": "DocuSign",
  "status": "preview",
  "summary": "Send and track signature envelopes with receipt-backed outputs."
}
```

### IF.BUS Carrier Manifest
- schema_path: schemas/if-bus/carrier_manifest.schema.json
- product_id: if.bus
- concept_id: if.bus.carrier_manifest

Fields:
- `schema_version` (string): Schema version for the manifest payload.
- `generated_utc` (string): UTC timestamp when the manifest was generated.
- `carriers` (array): Carrier entries included in the manifest.
- `source` (object)

Example:
```json
{
  "carriers": [
    {
      "capabilities": [
        "send",
        "status",
        "audit_log"
      ],
      "carrier_id": "docusign",
      "category": "connector",
      "demo_share_id": "HmlXcqae8heBq1siMrIRyw",
      "docs_url": "https://developers.docusign.com/",
      "label": "DocuSign",
      "provider": "DocuSign",
      "status": "preview",
      "summary": "Send and track signature envelopes with receipt-backed outputs."
    }
  ],
  "generated_utc": "2026-01-07T16:30:00Z",
  "schema_version": "1.0.0",
  "source": {
    "inventory_path": "docs/32-if-api-integrations-inventory.md",
    "notes": "Inventory-driven carrier list."
  }
}
```

### IF.API Adapter
- schema_path: schemas/if-api/adapter.schema.json
- product_id: if.api
- concept_id: if.api.adapter

Fields:
- `adapter_id` (string): Stable adapter identifier.
- `provider` (string): Vendor or platform name.
- `label` (string): Human-readable adapter label.
- `version` (string): Adapter spec version string.
- `base_url` (string): Primary API base URL.
- `auth` (object)
- `capabilities` (array): High-level capabilities exposed by the adapter.
- `webhooks` (array)
- `status` (string): Adapter readiness status.

Example:
```json
{
  "adapter_id": "docusign",
  "auth": {
    "scopes": [
      "signature",
      "envelope.read"
    ],
    "type": "oauth2"
  },
  "base_url": "https://demo.example.invalid/api",
  "capabilities": [
    "send",
    "status",
    "audit_log"
  ],
  "label": "DocuSign API",
  "provider": "DocuSign",
  "status": "preview",
  "version": "2026-01",
  "webhooks": [
    {
      "delivery": "webhook",
      "event": "completed",
      "name": "envelope.completed"
    }
  ]
}
```

### IF.API Adapter Spec
- schema_path: schemas/if-api/adapter_spec.schema.json
- product_id: if.api
- concept_id: if.api.adapter_spec

Fields:
- `spec_id` (string): Stable identifier for the adapter spec payload.
- `adapter` (ref: adapter.schema.json)
- `carrier_manifest_ref` (string): Reference to the carrier manifest used to build the adapter.
- `endpoints` (array)
- `constraints` (object)

Example:
```json
{
  "adapter": {
    "adapter_id": "docusign",
    "auth": {
      "scopes": [
        "signature",
        "envelope.read"
      ],
      "type": "oauth2"
    },
    "base_url": "https://demo.example.invalid/api",
    "capabilities": [
      "send",
      "status",
      "audit_log"
    ],
    "label": "DocuSign API",
    "provider": "DocuSign",
    "status": "preview",
    "version": "2026-01",
    "webhooks": [
      {
        "delivery": "webhook",
        "event": "completed",
        "name": "envelope.completed"
      }
    ]
  },
  "carrier_manifest_ref": "schemas/if-bus/carrier_manifest.schema.json",
  "constraints": {
    "max_payload_bytes": 1048576,
    "rate_limit": "60/min"
  },
  "endpoints": [
    {
      "method": "POST",
      "name": "create_envelope",
      "path": "/envelopes",
      "summary": "Create a signature envelope."
    },
    {
      "method": "GET",
      "name": "get_status",
      "path": "/envelopes/{id}",
      "summary": "Fetch envelope status."
    }
  ],
  "spec_id": "if-api-docusign-2026-01"
}
```

## Demos (receipt-backed)

### Adobe Sign demo
- product_id: if.api
- share_id: U2USOHGE8j715whbmsBr0Q
- receipt_url:
https://infrafabric.io/static/trace/U2USOHGE8j715whbmsBr0Q
- review_url:
https://infrafabric.io/static/hosted/review/if-api-adobe-sign-demo/2026-01-07/index.html
- inventory_path: docs/32-if-api-integrations-inventory.md
- notes: Receipt-backed demo (inventory Integration O).

### DocuSign demo
- product_id: if.api
- share_id: HmlXcqae8heBq1siMrIRyw
- receipt_url:
https://infrafabric.io/static/trace/HmlXcqae8heBq1siMrIRyw
- review_url:
https://infrafabric.io/static/hosted/review/if-api-docusign-demo/2026-01-07/index.html
- inventory_path: docs/32-if-api-integrations-inventory.md
- notes: Receipt-backed demo (inventory Integration P).

### Workato demo
- product_id: if.api
- share_id: Z7cho6wS6grqOFVqfAQpSw
- receipt_url:
https://infrafabric.io/static/trace/Z7cho6wS6grqOFVqfAQpSw
- review_url:
https://infrafabric.io/static/hosted/review/if-api-workato-demo/2026-01-07/index.html
- inventory_path: docs/32-if-api-integrations-inventory.md
- notes: Receipt-backed demo (inventory Integration T).

## Code snippets

### Adobe Sign demo input payload
Path: scripts/if_api_adobe_sign_demo.py (lines 44-61)
```python
def build_input_payload() -> dict:
    return {
        "integration": "adobe.sign",
        "schema_version": "demo.v1",
        "requested_at": CREATED_AT,
        "requested": [
            {
                "agreement_name": "Demo NDA",
                "document_name": "demo-nda.pdf",
                "signers": [
                    {"role": "signer", "email": "alpha@example.com"},
                    {"role": "counter_signer", "email": "beta@example.com"},
                ],
                "signature_type": "electronic",
            }
        ],
        "note": "synthetic mapping; no live Adobe Sign API call in this demo",
    }
```

### DocuSign demo input payload
Path: scripts/if_api_docusign_demo.py (lines 44-61)
```python
def build_input_payload() -> dict:
    return {
        "integration": "docusign",
        "schema_version": "demo.v1",
        "requested_at": CREATED_AT,
        "requested": [
            {
                "envelope_name": "Demo Agreement",
                "document_name": "demo-agreement.pdf",
                "recipients": [
                    {"role": "signer", "email": "alpha@example.com"},
                    {"role": "cc", "email": "beta@example.com"},
                ],
                "signature_type": "electronic",
            }
        ],
        "note": "synthetic mapping; no live DocuSign API call in this demo",
    }
```

### Workato demo output mapping
Path: scripts/if_api_workato_demo.py (lines 67-83)
```python
def build_output_payload(input_bytes: bytes, input_data: dict) -> dict:
    mapping = {
        "rcp_3101": {
            "trigger": "salesforce.new_lead",
            "action": "slack.post_message",
            "status": "enabled",
            "owner": "demo.builder@example.com",
            "link": "https://www.workato.com/recipes/3101",
        },
        "rcp_3102": {
            "trigger": "github.issue_opened",
            "action": "google.sheets.append_row",
            "status": "paused",
            "owner": "demo.builder@example.com",
            "link": "https://www.workato.com/recipes/3102",
        },
    }
```
