技能 数据科学 配置Clari API认证与数据导出

配置Clari API认证与数据导出

v20260423
clari-install-auth
本指南详细介绍了如何为Clari设置安全的API访问权限。学习生成API凭证、配置环境变量以及测试连接,从而将关键的收入情报和预测数据导出到数据仓库(如Snowflake或BigQuery)。内容覆盖了标准Clari API和Copilot API的集成步骤。
获取技能
254 次下载
概览

Clari Install & Auth

Overview

Set up Clari API access for exporting forecast data, pipeline snapshots, and revenue intelligence to your data warehouse. Clari uses API key authentication via the apikey header, with the primary API at api.clari.com/v4/.

Prerequisites

  • Clari enterprise account with API access enabled
  • Admin or RevOps role for API key generation
  • Target data warehouse (Snowflake, BigQuery, or Redshift) for exports

Instructions

Step 1: Generate API Token

  1. Log in to Clari at https://app.clari.com
  2. Navigate to User Settings > API Token
  3. Click Generate New API Token
  4. Copy and store the token securely
# Store securely -- never commit
export CLARI_API_KEY="your-api-token-here"

# Verify the key works
curl -s -H "apikey: ${CLARI_API_KEY}" \
  https://api.clari.com/v4/export/forecast/list \
  | jq '.forecasts | length'

Step 2: Configure Environment

# .env -- NEVER commit this file
CLARI_API_KEY=your-api-token
CLARI_BASE_URL=https://api.clari.com/v4
CLARI_ORG_ID=your-org-id

# .gitignore
.env
.env.local

Step 3: Test API Connectivity

import requests
import os

api_key = os.environ["CLARI_API_KEY"]
headers = {"apikey": api_key, "Content-Type": "application/json"}

# List available forecasts
response = requests.get(
    "https://api.clari.com/v4/export/forecast/list",
    headers=headers,
)
response.raise_for_status()

forecasts = response.json()["forecasts"]
for fc in forecasts:
    print(f"  {fc['forecastName']} (ID: {fc['forecastId']})")

Step 4: Copilot API Setup (Optional)

Clari Copilot (conversation intelligence) has a separate API:

# Copilot uses OAuth2 -- different from the forecast API
# Register at https://api-doc.copilot.clari.com

export CLARI_COPILOT_CLIENT_ID="your-client-id"
export CLARI_COPILOT_CLIENT_SECRET="your-client-secret"

# Get access token
curl -X POST https://api.copilot.clari.com/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=${CLARI_COPILOT_CLIENT_ID}" \
  -d "client_secret=${CLARI_COPILOT_CLIENT_SECRET}"

Error Handling

ErrorCauseSolution
401 UnauthorizedInvalid or expired tokenRegenerate at User Settings > API Token
403 ForbiddenInsufficient permissionsContact Clari admin for API access
404 Not FoundWrong API version or endpointUse /v4/ prefix
Connection refusedIP allowlistCheck with IT for API access from your network

Resources

Next Steps

Proceed to clari-hello-world to export your first forecast.

信息
分类 数据科学
名称 clari-install-auth
版本 v20260423
大小 3.41KB
更新时间 2026-04-28
语言