SAP Business ByDesign API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "sap_business_by_design",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "instance_url": "your_sap_business_bydesign_instance_url",
    "password": "your_sap_business_bydesign_password",
    "username": "your_sap_business_bydesign_username",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`instance_url`	The SAP Business ByDesign instance URL.
`password`	The SAP Business ByDesign password.
`username`	The SAP Business ByDesign username.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the username, password and instance_url parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "sap_business_by_design",
  "group_id": "group_id",
  "config": {
    "username": "your_sap_business_bydesign_username",
    "password": "your_sap_business_bydesign_password",
    "instance_url": "your_sap_business_bydesign_instance_url"
  }
}

By using the Connect Card or the Fivetran dashboard.