Skip to main content

Quick Start

The Istari Digital Platform does not expose a public API. Instead, the supported way to programmatically interact with the platform is through the official Istari Digital Client, available for Python.

Installation​

To get started, install the Python client from PyPI using pip or a tool like uv:

pip install istari-digital-client

Basic Usage​

The core entry point is the Client object, which is initialized using a Configuration object. Here's a minimal example suitable for experimentation in a Python notebook:

from istari_digital_client import Client, Configuration

config = Configuration(
    registry_url="my-istari-digital-url",
    registry_auth_token="my-istari-digital-auth-token",
)

client = Client(config)
  • Registry URL: You can find your company's Registry URL under Settings > Developer Settings in the Istari Digital app.
  • Registry Token: See the Personal Access Token guide for instructions on creating an authentication token for your Istari Digital Platform instance.

Managing Secrets in Production​

For production code, we recommend storing secrets outside of your source code—for example, in a .env file. This helps avoid accidentally committing sensitive credentials to version control.

Here's an example using the python-dotenv package:

import os
from dotenv import load_dotenv
from istari_digital_client import Client, Configuration

load_dotenv()

config = Configuration(
    registry_url=os.getenv("ISTARI_DIGITAL_REGISTRY_URL"),
    registry_auth_token=os.getenv("ISTARI_DIGITAL_REGISTRY_AUTH_TOKEN"),
)

client = Client(config)

To create a .env file, add your credentials like this:

ISTARI_DIGITAL_REGISTRY_URL=https://your-istari-url
ISTARI_DIGITAL_REGISTRY_AUTH_TOKEN=your-auth-token

💡 Don't forget to add .env to your .gitignore file to keep it out of version control.

Download the SDK documentation​

Click here to download the SDK documentation as a txt file.