Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@citiwave/impactmap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ImpactMap SDK

Official SDK for impactmap.io - CRM for impact management

Installation

npm install impactmap

yarn add impactmap

Usage

Authentication

First, set your API key for the environment you want to use:

impactmap set-key <environment> <api-key>

List Available Environments

To list all available ImpactMap environments, you'll need to set the internal API key. You have two options:

Using a .env file in your project root:

# .env file
IMPACTMAP_INTERNAL_API_KEY=your_internal_api_key

Setting it as an environment variable:

# Linux/macOS
export IMPACTMAP_INTERNAL_API_KEY=your_internal_api_key

# Windows PowerShell
$env:IMPACTMAP_INTERNAL_API_KEY='your_internal_api_key'

Then you can list the environments:

impactmap list-tenants

This will display a table of all available environments with their names, slugs, statuses, and URLs.

API Reference

TenantsAPI

The TenantsAPI class provides methods for interacting with ImpactMap tenants:

import { ImpactMap } from 'impactmap';

const client = new ImpactMap({
  apiKey: 'your-api-key'
});

// List all tenants (requires IMPACTMAP_INTERNAL_API_KEY in .env or environment)
const tenants = await client.tenants.list();

// Get a specific tenant by slug
const tenant = await client.tenants.get('environment-slug');

// Example: Get all projects
const projects = await client.projects.list();

Environment Variables

IMPACTMAP_INTERNAL_API_KEY: Required for tenant listing functionality. This is an internal API key that should be kept secure. Can be set in a .env file or as an environment variable.

Documentation

For detailed documentation, visit docs.impactmap.io.

License

MIT