Oracle E-Business Suite Python API Docs | dltHub

Oracle E-Business Suite (EBS) Integrated SOA Gateway (ISG) provides REST services for interacting with EBS interface types such as PL/SQL and Java APIs. The REST API base URL is https://{host}:{port}/webservices/rest and all requests require either HTTP Basic Authentication or a session ID token provided as a Cookie.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Oracle E-Business Suite data in under 10 minutes.

---

What data can I load from Oracle E-Business Suite?

Here are some of the endpoints you can load from Oracle E-Business Suite:

---

How do I authenticate with the Oracle E-Business Suite API?

Oracle E-Business Suite REST APIs support HTTP Basic Authentication (username and password) or token-based authentication. Token-based authentication requires the session ID (e.g., JSESSIONID) to be passed as a Cookie in the HTTP header after initial authentication via the Login service.

1. Get your credentials

Oracle E-Business Suite (EBS) does not use a traditional API key setup dashboard for REST services. Instead, it utilizes standard HTTP Basic Authentication or Token-Based Authentication. To obtain credentials: 1. Ensure your user account is configured within Oracle EBS with the appropriate permissions to access the Integrated SOA Gateway (ISG). 2. For Basic Authentication, use your standard Oracle EBS username and password. 3. For Token-Based Authentication, first authenticate using your username/password via the /login endpoint to receive a session token (Oracle EBS Session ID), which is returned as a cookie or in the response body. This token is then passed in the header of subsequent requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.oracle_e_business_suite_source]
username = "your_ebs_username"
password = "your_ebs_password"
# base_url = "https://your-ebs-host:port/webservices/rest"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Oracle E-Business Suite API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python oracle_e_business_suite_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline oracle_e_business_suite_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset oracle_e_business_suite_data
The duckdb destination used duckdb:/oracle_e_business_suite.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads /login and /{serviceAlias}/{methodName} from the Oracle E-Business Suite API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def oracle_e_business_suite_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{host}:{port}/webservices/rest",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "hr_organizations", "endpoint": {"path": "hr/organizations", "data_selector": "items"}},
            {"name": "employees", "endpoint": {"path": "employees", "data_selector": "items"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="oracle_e_business_suite_pipeline",
        destination="duckdb",
        dataset_name="oracle_e_business_suite_data",
    )
    load_info = pipeline.run(oracle_e_business_suite_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("oracle_e_business_suite_pipeline").dataset()
sessions_df = data.hr_organizations.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM oracle_e_business_suite_data.hr_organizations LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("oracle_e_business_suite_pipeline").dataset()
data.hr_organizations.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Oracle E-Business Suite data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack