Load SuperOffice data in Python using dltHub

Build a SuperOffice-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

In this guide, we'll set up a complete SuperOffice data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def superoffice_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "http://localhost/WebApi/api/v1/Agents/Relation",
            "auth": {
                "type": "bearer",
                "token": access_token,
            }
        },
        "resources": [
            "DeleteContactRelation", "SaveContactRelation"
        ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='superoffice_pipeline',
        destination='duckdb',
        dataset_name='superoffice_data', 
    )
    # Load the data
    load_info = pipeline.run(superoffice_source())
    print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

  • Accelerate pipeline development with AI-native context
  • Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
  • Build Python notebooks for end users of your data
  • Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
  • dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from superoffice’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

  • Agents Relation Endpoints:

    • /WebApi/api/v1/Agents/Relation/CreateDefaultContactRelationEntity: Creates a default contact relation entity.
    • /WebApi/api/v1/Agents/Relation/GetContactRelationEntity: Retrieves a contact relation entity.
    • /WebApi/api/v1/Agents/Relation/SaveContactRelation: Saves a contact relation.
    • /WebApi/api/v1/Agents/Relation/DeleteContactRelation: Deletes a contact relation.

  • Web Panel Endpoints:

    • /WebApi/api/v1/List/WebPanel: Accesses the web panel list.
    • /WebApi/api/v1/List/WebPanel/Items/{id}: Retrieves specific items from the web panel by ID.
    • /WebApi/api/v1/List/WebPanel/Items: Accesses items from the web panel.

  • Other Services:

    • /NetServer/Services88: Endpoint for a specific network server service.
    • /SuperOfficeNS/ServicesXX: Endpoint for SuperOffice network services.

You will then debug the SuperOffice pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, let's make sure Cursor is set up correctly:

Now you're ready to get started!

  1. ⚙️ Set up dlt Workspace

    Install dlt with duckdb support:

    pip install "dlt[workspace]"

    Initialize a dlt pipeline with SuperOffice support.

    dlt init dlthub:superoffice duckdb

    The init command will setup the necessary files and folders for the next step.

  2. 🤠 Start LLM-assisted coding

    Here’s a prompt to get you started:

    Prompt
    Please generate a REST API Source for SuperOffice API, as specified in @superoffice-docs.yaml 
Start with endpoints DeleteContactRelation and SaveContactRelation and skip incremental loading for now. 
Place the code in superoffice_pipeline.py and name the pipeline superoffice_pipeline. 
If the file exists, use it as a starting point. 
Do not add or modify any other files. 
Use @dlt rest api as a tutorial. 
After adding the endpoints, allow the user to run the pipeline with python superoffice_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    To use the SuperOffice web API, you need to provide BASIC authentication by Base64 encoding your SuperOffice username and password, or use SOTICKET authentication by passing the SuperOffice ticket (7T:abc123==) without any encoding, or utilize BEARER authentication by passing an access token (7A:abc123==) from SuperId. Additionally, if you do not specify an Authorization header, the API will attempt to log in using the current user's session.

    To get the appropriate API keys, please visit the original source at https://docs.superoffice.com/en/api/reference/restful/rest/index.html. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

  4. 🏃‍♀️ Run the pipeline in the Python terminal in Cursor

    python superoffice_pipeline.py

    If your pipeline runs correctly, you’ll see something like the following:

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

  5. 📈 Debug your pipeline and data with the Pipeline Dashboard

    Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:

    • Pipeline overview: State, load metrics
    • Data’s schema: tables, columns, types, hints
    • You can query the data itself
    dlt pipeline superoffice_pipeline show

  6. 🐍 Build a Notebook with data explorations and reports

    With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.

    import dlt

data = dlt.pipeline("superoffice_pipeline").dataset()
# get "DeleteContactRelation" table as Pandas frame
data."DeleteContactRelation".df().head()

Extra resources:

Next steps