界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
效率与协作 · SKILL.md

customerio-install-auth

customerio-install-auth

【效率与协作】Install and configure Customer.io SDK/CLI authentication. Use when setting up a new Customer.io integration, configuring API keys, or initializing Customer.io in your project. Trigger with phrases like "install customer.io", "setup customer.io", "customer.io auth", "configure customer.io API key".

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: customerio-install-auth description: | Install and configure Customer.io SDK/CLI authentication. Use when setting up a new Customer.io integration, configuring API keys, or initializing Customer.io in your project. Trigger with phrases like "install customer.io", "setup customer.io", "customer.io auth", "configure customer.io API key". allowed-tools: Read, Write, Edit, Bash(npm:), Bash(pip:), Grep version: 1.0.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io

Customer.io Install & Auth

Overview

Set up Customer.io SDK and configure authentication credentials for email, push, SMS, and in-app messaging automation.

Prerequisites

  • Node.js 18+ or Python 3.10+
  • Package manager (npm, pnpm, or pip)
  • Customer.io account with API access
  • Site ID and API Key from Customer.io dashboard

Instructions

Step 1: Install SDK

# Node.js (Track API)
npm install customerio-node

# Node.js (Journeys Track API - recommended)
npm install @customerio/track

# Python
pip install customerio

Step 2: Configure Authentication

# Set environment variables
export CUSTOMERIO_SITE_ID="your-site-id"
export CUSTOMERIO_API_KEY="your-api-key"

# Or create .env file
cat >> .env << 'EOF'
CUSTOMERIO_SITE_ID=your-site-id
CUSTOMERIO_API_KEY=your-api-key
EOF

Step 3: Verify Connection

import { TrackClient, RegionUS } from '@customerio/track';

const client = new TrackClient(
  process.env.CUSTOMERIO_SITE_ID,
  process.env.CUSTOMERIO_API_KEY,
  { region: RegionUS }
);

// Test by identifying a user
await client.identify('test-user', { email: 'test@example.com' });
console.log('Customer.io connection successful');

Output

  • Installed SDK package in node_modules or site-packages
  • Environment variables or .env file with Site ID and API Key
  • Successful connection verification output

Error Handling

ErrorCauseSolution
Invalid API KeyIncorrect or expired keyVerify key in Customer.io Settings > API Credentials
Invalid Site IDWrong site identifierCheck Site ID in Customer.io Settings
401 UnauthorizedAuthentication failedEnsure both Site ID and API Key are correct
Network ErrorFirewall blockingEnsure outbound HTTPS to track.customer.io allowed
Module Not FoundInstallation failedRun npm install or pip install again

Examples

TypeScript Setup

import { TrackClient, RegionUS, RegionEU } from '@customerio/track';

// US region (default)
const client = new TrackClient(
  process.env.CUSTOMERIO_SITE_ID!,
  process.env.CUSTOMERIO_API_KEY!,
  { region: RegionUS }
);

// EU region
const euClient = new TrackClient(
  process.env.CUSTOMERIO_SITE_ID!,
  process.env.CUSTOMERIO_API_KEY!,
  { region: RegionEU }
);

Python Setup

import os
from customerio import CustomerIO

cio = CustomerIO(
    site_id=os.environ.get('CUSTOMERIO_SITE_ID'),
    api_key=os.environ.get('CUSTOMERIO_API_KEY')
)

Resources

Next Steps

After successful auth, proceed to customerio-hello-world for your first API call.

我的收藏