Eway-crm Python API Docs | dltHub

eWay-CRM is a CRM platform exposing an RPC-style REST API to query and manipulate CRM data (contacts, companies, tasks, items, changes, etc.). The REST API base URL is https://free.eway-crm.com/{instanceId} and OAuth2 access token (Bearer) is required for modern LogIn; legacy LogIn (MD5) exists but is deprecated/limited..

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 pip install "dlt[workspace]" and start loading Eway-crm data in under 10 minutes.

---

What data can I load from Eway-crm?

Here are some of the endpoints you can load from Eway-crm:

---

How do I authenticate with the Eway-crm API?

Obtain OAuth2 client credentials on your eWay-CRM instance, exchange for an access token via the LogIn OAuth method, and send Authorization: Bearer <access_token> on requests. Legacy LogIn accepts username and MD5(password) returning a SID for session‑based calls.

1. Get your credentials

1. Connect to your eWay-CRM SQL Server.
2. Execute the stored procedure to register an API client: EXEC dbo.eWaySP_Auth_CreateClient 'Postman','https://oauth.pstmn.io/v1/browser-callback';
3. Restart the eWay-CRM web service to load the new client.
4. Query the EWD_AuthClients table to obtain the generated ClientID and ClientSecret: SELECT ClientID, ClientSecret FROM EWD_AuthClients WHERE ClientName = 'Postman';
5. Use these values as client_id and client_secret in the OAuth2 LogIn flow to obtain an access token.

2. Add them to .dlt/secrets.toml

Copy
[sources.eway_crm_source]
client_id = "your_client_id"
client_secret = "your_client_secret"

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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt 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
dlt ai toolkit rest-api-pipeline install

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 Eway-crm 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
python eway_crm_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline eway_crm_pipeline 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 get_contacts and get_companies from the Eway-crm 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 eway_crm_source(client_id=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://free.eway-crm.com/{instanceId}",
            "auth": {
                "type": "bearer",
                "access_token": client_id,
            },
        },
        "resources": [
            {"name": "get_contacts", "endpoint": {"path": "GetContacts", "data_selector": "Items"}},
            {"name": "get_companies", "endpoint": {"path": "GetCompanies", "data_selector": "Items"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="eway_crm_pipeline",
        destination="duckdb",
        dataset_name="eway_crm_data",
    )
    load_info = pipeline.run(eway_crm_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("eway_crm_pipeline").dataset()
sessions_df = data.get_contacts.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM eway_crm_data.get_contacts LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("eway_crm_pipeline").dataset()
data.get_contacts.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 Eway-crm 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.

---

Troubleshooting

Authentication failures

If you receive rcBadAccessToken or rcLoginFailed: verify you used OAuth LogIn to obtain a bearer token for your instance (or legacy SID where supported). Ensure client_id/client_secret were created on your eWay-CRM server and Web Service restarted after creation.

Item changes / pagination and delta sync

GetChanges/ItemChanges only retain ~30 days of changes. If you supply a base change id older than retention you may receive rcBaseItemChangeIdNotFound and must fallback to a full re-sync using Get methods.

Permissions and access denied

rcAccessDenied indicates your user or client lacks required permissions for the resource; check eWay-CRM user roles and API client scope.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

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

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

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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