Skip to main content

Import IB API

The Public Import IB API enables you to import one or more Integration Bridges (IBs) directly from a human-readable .json file  without full authentication or backend configuration. Perfect for rapid deployment, migration, or automation of data workflows.

Method: POST

URL: {{base_url}}/api/importapi?client_id=<your_client_id>

Authentication

Required Parameters:

Parameter Name Value Description
client_id your_client_id API authentication ID 

Required Headers:


Header Name Value Description
client-secret your_client_secret API authentication secret
Content-Type multipart/form-data Form data upload

Supported Source &and Target TypesTypes:

Source Types
  • API (HTTPS, FTP, SFTP, SOAP/REST/GraphQL)
  • Database
  • Bizintel360 Data Lake Source
  • WebSocket
  • Email

Target Types

  • API (HTTPS, FTP, SFTP, SOAP/REST/GraphQL)
  • Database
  • Bizintel360 Data Lake Ingestion
  • Email
  • No Target

Data Operations (Optional)
:

Add transformation steps inside "Data Operations":

json


"Data Operations": {
  "Single To Multiline": {
    "Chop Key": "['data']"
  },
  "Text To Operations": {
    "User Question": "convert 'data' into uppercase.",
    "Move Code": "true"
  },
  "Single To Multiline 2": {
    "Chop Key": "['bizdata_dataset_response']['data']",
    "Mute": true
  }
}



Supported Operations:

  • Single To Multiline
  • Text To Operations
  • AI Operation

  • Use numbered suffixes (e.g., Single To Multiline 2) to preserve order.

    • Sample JSON Files
    Files:

    API to API (Basic)

    json


    {
  "file_name": "2025-10-10 10:47:47",
  "data": [
    {
      "Source Type": "API (HTTPS, FTP, SFTP, SOAP/REST/ GraphQL)",
      "Product Name": "Humanoid",
      "Source Business Object": "List Users (Method: GET)",
      "Source Parameters": {
        "Endpoint URL": "https://reqres.in/api/users?",
        "Method": "GET",
        "Endpoint Params": [
          { "key": "page", "value": "{%min_num%}" },
          { "key": "per_page", "value": "{%max_num%}" }
        ],
        "Pagination": {
          "Pagination Style": "total_pages",
          "Data Collection Key": "['data']",
          "User key": "total_pages",
          "Key Name to update": "page"
        },
        "Numeric Params": { "Minimum Number": 1, "Maximum Number": 6 }
      },
      "Target Type": "API (HTTPS, FTP, SFTP, SOAP/REST/ GraphQL)",
      "Target Name": "Acumatica ERP",
      "Target Business Object": "Create a Work Location (Method: PUT)",
      "Target Parameters": { /* ... */ },
      "Integration Bridge Name": "api to api",
      "Schedule": {
        "Timer Type": "interval",
        "Interval in seconds": 60
      },
      "Event Email": "pshravya@bizdata360.com"
    }
  ]
}



    Database to Database

    json


    {
  "data": [
    {
      "Source Type": "Database",
      "Source Storage Name": "Oracle Database",
      "Source Host IP": "150.136.89.119",
      "Source Port Number": "1521",
      "Source Schema Name": "prod",
      "Source User Name": "bizdata",
      "Source Password": "bizdata123",
      "Source SQL Statement": "select * from R_1_MILLION_SOURCE fetch first 5000 rows only",
      "Target Type": "Database",
      "Target SQL Statement": "\"\"Insert into SALES_ITEMS(...) values (?,?,?,?,?,?,?,?)\"\"\"",
      "Integration Bridge Name": "DB to DB - JSON"
    }
  ]
}



    Multiple IBs (Mixed Types)Type)

    json


    {
  "file_name": "2025-10-10 10:57:49",
  "data": [
    { "Integration Bridge Name": "API to NO TARGET - JSON", "Target Type": "No Target" },
    { "Integration Bridge Name": "DB to DB - JSON", "Source Type": "Database" },
    { "Integration Bridge Name": "Advanced API Flow", "Advance Settings": { "Number Of Workers": 2 } }
  ]
}



    Features of Public Import IB API:

    • Batch Import Upload multiple IBs in a single request.

    • Zero Backend Access No need to log in or configure systems manually.


      • Secure Credentials Use Target Environment Variable with type: "secret".

    • Flexible Scheduling Supports cron or interval triggers per IB.

    • Advanced Tuning Set workers, chunk size, logging, and multiprocessing.


    No Target ModeNotes: Collect data without sending it anywhere.

    Notes:

    • File Structure: Wrap IBs in "data": []. Optional "file_name" for tracking.
    • Environment Variables: Define once under "Target Environment Variable" and reuse.
    • Validation: Invalid JSON or credentials → full rejection with error details.
    • Order Preservation: Numbered operations (e.g., 2, 3) execute sequentially.
    Sample

    Response

    Response:
    json


    {
  "msg": {
    "number_of_ib_imported": 2,
    "number_of_ib_failed_imports": 0,
    "failed_ibs": [],
    "successfully_imported_ib": [
      "API to NO TARGET - JSON",
      "DB to DB - JSON"
    ]
  }
}



    Authentication Instructions:

    To acquire the Base URL, Client ID, and Secret, please refer to the My Profile section within your Bizdata account.

    Back to top