Back to Details

instantly-install-auth

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Instantly Install & Auth

Instantly 安装与认证

Overview

概述

Set up Instantly SDK/CLI and configure authentication credentials.
设置Instantly SDK/CLI并配置认证凭据。

Prerequisites

前置条件

  • Node.js 18+ or Python 3.10+
  • Package manager (npm, pnpm, or pip)
  • Instantly account with API access
  • API key from Instantly dashboard
  • Node.js 18+ 或 Python 3.10+
  • 包管理器（npm、pnpm 或 pip）
  • 拥有API访问权限的Instantly账户
  • 来自Instantly控制台的API密钥

Instructions

操作步骤

Step 1: Install SDK

步骤1：安装SDK

bash
undefined
bash
undefined

Node.js

Node.js

npm install @instantly/sdk
npm install @instantly/sdk

Python

Python

pip install instantly
undefined
pip install instantly
undefined

Step 2: Configure Authentication

步骤2：配置认证

bash
undefined
bash
undefined

Set environment variable

设置环境变量

export INSTANTLY_API_KEY="your-api-key"
export INSTANTLY_API_KEY="your-api-key"

Or create .env file

或创建.env文件

echo 'INSTANTLY_API_KEY=your-api-key' >> .env
undefined
echo 'INSTANTLY_API_KEY=your-api-key' >> .env
undefined

Step 3: Verify Connection

步骤3：验证连接

typescript
// Test connection code here
typescript
// Test connection code here

Output

输出结果

  • Installed SDK package in node_modules or site-packages
  • Environment variable or .env file with API key
  • Successful connection verification output
  • SDK包已安装至node_modules或site-packages
  • 包含API密钥的环境变量或.env文件
  • 连接验证成功的输出信息

Error Handling

错误处理

ErrorCauseSolution
Invalid API KeyIncorrect or expired keyVerify key in Instantly dashboard
Rate LimitedExceeded quotaCheck quota at https://docs.instantly.com
Network ErrorFirewall blockingEnsure outbound HTTPS allowed
Module Not FoundInstallation failedRun 
npm install
or 
pip install
again
错误类型原因解决方案
无效API密钥密钥错误或已过期在Instantly控制台中验证密钥
请求受限超出配额查看配额：https://docs.instantly.com
网络错误防火墙拦截确保允许HTTPS出站请求
模块未找到安装失败重新运行
npm install
或
pip install

Examples

示例

TypeScript Setup

TypeScript 配置示例

typescript
import { InstantlyClient } from '@instantly/sdk';

const client = new InstantlyClient({
  apiKey: process.env.INSTANTLY_API_KEY,
});
typescript
import { InstantlyClient } from '@instantly/sdk';

const client = new InstantlyClient({
  apiKey: process.env.INSTANTLY_API_KEY,
});

Python Setup

Python 配置示例

python
from instantly import InstantlyClient

client = InstantlyClient(
    api_key=os.environ.get('INSTANTLY_API_KEY')
)
python
from instantly import InstantlyClient

client = InstantlyClient(
    api_key=os.environ.get('INSTANTLY_API_KEY')
)

Resources

相关资源

Next Steps

下一步操作

After successful auth, proceed to 
instantly-hello-world
for your first API call.
认证成功后，可继续执行
instantly-hello-world
完成首次API调用。