Skip to main content

Basic Configuration

Configuration Options

string
Your Artu API key. Falls back to the ARTU_API_KEY environment variable if not provided.
'test' | 'live'
default:"test"
Environment to connect to. Falls back to ARTU_ENVIRONMENT env var.
Scope
Optional. Scope the SDK to a specific scope and/or activity using a colon-separated string (e.g., "MX", "MX:AV:AVI", "MX:CNBV:TRANSMISOR").
string
Optional. Custom API base URL. Falls back to ARTU_BASE_URL env var, then the default production URL.
number
default:"30000"
Request timeout in milliseconds.

Environments

The SDK supports two environments:
API keys have scoped permissions that control which environments they can access. See API Keys for details.

Authentication

API Key

Authenticate with your Artu API key for server-side scripts, backend services, and CI:

Environment Variables

The SDK auto-resolves these environment variables when options are not explicitly provided:

Scoped SDKs

Scope your SDK to a scope for simplified operations:
For Mexican vulnerable activities:
For CNBV money transmitters:
Learn more about scoping in the SDK Scoping concept guide.

Scope Properties

The SDK exposes properties to check the current configuration:

Multiple SDK Instances

You can create multiple SDK instances for different configurations:

Sub-Exports

Import scoped SDKs directly for better TypeScript types: