Pre-release
This release is a pre-release and may not be stable for production use.
wandelbots-api-client
Interact with robots in an easy and intuitive way.
- Compatible API version: 1.5.0 (can be found at the home screen of your instance -> API)
- Package version: 26.5.4rc3
Requirements.
Python >=3.11, Python < 4.0
Installation
pip install wandelbots-api-client
OR with uv:
uv init
uv add wandelbots-api-client
Authentication
The SDK supports OAuth2 device code flow authentication for both Entra ID (formerly Azure AD) and Auth0. This authentication method is ideal for CLI applications, scripts, and headless environments.
Entra ID (Azure AD) Authentication
import asyncio
from wandelbots_api_client import ApiClient, Configuration
from wandelbots_api_client.authorization import EntraIDConfig
async def main():
# Initialize Entra ID config
auth = EntraIDConfig(
client_id="GIVEN_CLIENT_ID",
tenant_id="GIVEN_TENANT_ID",
scope="openid profile email offline_access GIVEN_CLIENT_ID\.default"
)
# Request device code
device_response = await auth.request_device_code()
# Display user instructions
print(f"\nPlease authenticate:")
print(f"1. Go to: {device_response['verification_uri']}")
print(f"2. Enter code: {device_response['user_code']}")
print(f"Waiting for authentication...\n")
# Poll for token (will wait until user completes authentication)
token_response = await auth.poll_token_endpoint(
device_code=device_response["device_code"],
interval=device_response.get("interval", 5),
expires_in=device_response.get("expires_in", 900)
)
print("Authentication successful!")
# Configure API client with access token
config = Configuration(
host="https://your-instance.wandelbots.io",
access_token=token_response["access_token"]
)
async with ApiClient(configuration=config) as api_client:
# Use the API client for authenticated requests
# Example: api = YourApi(api_client)
# result = await api.your_method()
pass
# Optionally refresh the token later
if "refresh_token" in token_response:
new_token = await auth.refresh_token(token_response["refresh_token"])
config.access_token = new_token["access_token"]
asyncio.run(main())
Auth0 Authentication
import asyncio
from wandelbots_api_client import ApiClient, Configuration
from wandelbots_api_client.authorization import Auth0Config
async def main():
# Initialize Auth0 config
auth = Auth0Config(
client_id="GIVEN_CLIENT_ID",
domain="auth.portal.wandelbots.io",
audience="GIVEN_AUDIENCE",
scope="openid profile email offline_access"
)
# Or use default config from template variables
# auth = Auth0Config.default()
# Request device code
device_response = await auth.request_device_code()
# Display user instructions
print(f"\nPlease authenticate:")
print(f"1. Go to: {device_response['verification_uri']}")
print(f"2. Enter code: {device_response['user_code']}")
print(f"Waiting for authentication...\n")
# Poll for token (will wait until user completes authentication)
token_response = await auth.poll_token_endpoint(
device_code=device_response["device_code"],
interval=device_response.get("interval", 5),
expires_in=device_response.get("expires_in", 900)
)
print("Authentication successful!")
# Configure API client with access token
config = Configuration(
host="https://XYZ.instances.wandelbots.io",
access_token=token_response["access_token"]
)
async with ApiClient(configuration=config) as api_client:
# Use the API client for authenticated requests
# Example: api = YourApi(api_client)
# result = await api.your_method()
pass
asyncio.run(main())
Token Refresh
To maintain long-lived sessions, use refresh tokens to obtain new access tokens:
# When your access token expires
if "refresh_token" in token_response:
refreshed = await auth.refresh_token(token_response["refresh_token"])
config.access_token = refreshed["access_token"]
# Update refresh token if a new one is provided
if "refresh_token" in refreshed:
token_response["refresh_token"] = refreshed["refresh_token"]
Complete Example with Error Handling
import asyncio
from wandelbots_api_client import ApiClient, Configuration
from wandelbots_api_client.authorization import EntraIDConfig
async def authenticate_and_call_api():
"""Complete example with error handling."""
try:
# Initialize authentication
auth = EntraIDConfig(
client_id="GIVEN_CLIENT_ID",
tenant_id="GIVEN_TENANT_ID",
scopen="openid profile email offline_access GIVEN_CLIENT_ID\.default"
)
# Verify configuration
if not auth.is_complete():
raise ValueError("Authentication configuration is incomplete")
# Request device code
device_response = await auth.request_device_code()
# Display instructions
print(f"\n{'='*60}")
print(f"AUTHENTICATION REQUIRED")
print(f"{'='*60}")
print(f"Visit: {device_response['verification_uri']}")
print(f"Enter code: {device_response['user_code']}")
print(f"{'='*60}\n")
# Wait for user to authenticate
token_response = await auth.poll_token_endpoint(
device_code=device_response["device_code"],
interval=device_response.get("interval", 5),
expires_in=device_response.get("expires_in", 900)
)
print("✓ Authentication successful!\n")
# Create API client
config = Configuration(
host="https://XYZ.instance.wandelbots.io",
access_token=token_response["access_token"]
)
async with ApiClient(configuration=config) as api_client:
# Make authenticated API calls here
# Example:
# from wandelbots_api_client.api import YourApi
# api = YourApi(api_client)
# result = await api.your_method()
print("API client ready for requests")
except TimeoutError:
print("Authentication timed out. Please try again.")
except ValueError as e:
print(f"Configuration error: {e}")
except Exception as e:
print(f"Authentication failed: {e}")
asyncio.run(authenticate_and_call_api())
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wandelbots_api_client-26.5.4rc3.tar.gz.
File metadata
- Download URL: wandelbots_api_client-26.5.4rc3.tar.gz
- Upload date:
- Size: 650.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Alpine Linux","version":"3.23.4","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f8f0afedea478fb647581d63ef6c4a271fa91a53885e928b401ff5abfc40708
|
|
| MD5 |
29f70e2f521b3c977ee5acc184887a97
|
|
| BLAKE2b-256 |
bf35687730bcaedb0265d3351ae129dda0a827073623a90c179755262f70b7ac
|
File details
Details for the file wandelbots_api_client-26.5.4rc3-py3-none-any.whl.
File metadata
- Download URL: wandelbots_api_client-26.5.4rc3-py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Alpine Linux","version":"3.23.4","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1110ed573a13287d331d3b5170c5ab10fca71b45b6997a8c3880480e7bdcc4a4
|
|
| MD5 |
294f003c67f5d5e41fee13849f381696
|
|
| BLAKE2b-256 |
612601f05b528cb509348d6ca480dc7f721d1cddfaae413fdd0360902466dd83
|
