MCP HubMCP Hub
스킬 목록으로 돌아가기

api-onboarding

jonathimer
업데이트됨 2 days ago
2 조회
76
4
76
GitHub에서 보기
메타wordaiapi

정보

이 Claude Skill은 인증, 샌드박스 환경, 대화형 문서를 최적화하여 개발자의 온보딩 마찰을 줄이는 데 도움을 줍니다. API 사용자의 첫 API 호출까지 걸리는 시간(TTFAC)을 최소화해야 할 때 사용하세요. 이 Skill은 초기 개발자 여정에서 흔히 발생하는 실패 지점을 식별하고 제거하는 데 중점을 둡니다.

빠른 설치

Claude Code

추천
기본
npx skills add jonathimer/devmarketing-skills -a claude-code
플러그인 명령대체
/plugin add https://github.com/jonathimer/devmarketing-skills
Git 클론대체
git clone https://github.com/jonathimer/devmarketing-skills.git ~/.claude/skills/api-onboarding

Claude Code에서 이 명령을 복사하여 붙여넣어 스킬을 설치하세요

문서

Reducing Time-to-First-API-Call

The time between a developer discovering your API and successfully making their first call is the most critical window in your entire developer journey. Every minute of friction here costs you potential users.

Overview

Time-to-First-API-Call (TTFAC) is the single most predictive metric for developer adoption. Developers who succeed quickly become active users. Developers who struggle leave—often silently.

This skill covers:

  • Measuring and optimizing TTFAC
  • Removing authentication friction
  • Creating effective sandbox environments
  • Building interactive documentation
  • Identifying and fixing common failure points

Before You Start

Review the developer-audience-context skill to understand:

  • What's the typical technical sophistication of your developers?
  • What tools and environments do they commonly use?
  • What alternative products have they tried? What was their experience?
  • What's their urgency level? (Evaluating vs. building immediately)

Your onboarding should meet developers where they are.

Understanding TTFAC

What TTFAC Measures

Time-to-First-API-Call measures the elapsed time from a developer's first interaction to their first successful API response. This includes:

  1. Discovery time: Finding the "Get Started" content
  2. Signup time: Creating an account
  3. Credential time: Obtaining API keys
  4. Setup time: Installing SDK, configuring environment
  5. Execution time: Running first request
  6. Success time: Receiving successful response

TTFAC Benchmarks

RatingTTFACDeveloper Experience
Excellent< 5 min"This is amazing"
Good5-15 min"Pretty straightforward"
Acceptable15-30 min"Got there eventually"
Poor30-60 min"This is frustrating"
Failing> 60 min"I'll try something else"

Measuring TTFAC

Instrumentation points:

// Track these events with timestamps
analytics.track('docs_quickstart_viewed');
analytics.track('signup_started');
analytics.track('signup_completed');
analytics.track('api_key_created');
analytics.track('sdk_installed');     // Via package manager data
analytics.track('first_api_call');    // Via API logs
analytics.track('first_successful_call');

Calculate:

  • Median TTFAC (more useful than average)
  • TTFAC by developer segment
  • Drop-off rates at each step
  • Success rates within time windows (5 min, 15 min, 60 min)

Authentication Simplification

Authentication is the #1 source of onboarding friction. Simplify ruthlessly.

The Ideal Auth Flow

  1. Developer signs up (< 2 minutes)
  2. API key visible immediately (not buried in settings)
  3. Key works immediately (no activation delay)
  4. Copy-paste into example code
  5. Success

Auth Anti-Patterns to Avoid

The Approval Queue

❌ "Your API access request has been submitted.
    You'll receive access within 2-3 business days."

Developers leave and find an alternative.

The Hidden Key

❌ Settings → Team → API → Credentials → Keys → Show Key

Make keys visible on dashboard home.

The Complex Token

❌ OAuth flow requiring:
   - Client ID
   - Client secret
   - Redirect URI configuration
   - Token exchange
   - Token refresh handling

For getting started, provide simple API keys.

The Verification Gauntlet

❌ Sign up → Verify email → Verify phone →
   Add payment → Verify payment → Then API key

Minimize friction for first API call.

Auth Simplification Strategies

Provide Test Keys Immediately

✅ "Here's your test API key: sk_test_abc123...
    Use this in sandbox mode—no charges, no setup."

Support Multiple Auth Methods

✅ Quickstart: API key header
   Production: OAuth when they need it

Pre-populate Examples

✅ # Your API key is pre-filled in these examples
   curl -H "Authorization: Bearer sk_test_YOUR_KEY" ...

Delay Production Requirements

✅ Test mode: Instant access
   Production mode: Add payment, verify identity (later)

Sandbox Environments

A sandbox removes the fear of "breaking something" and lets developers experiment freely.

Sandbox Requirements

Instant Access: No approval, no payment, no complex setup

Realistic Behavior: Same API, same responses, same errors

Clear Boundaries: Obvious when in sandbox vs. production

Reset Capability: Easy way to start fresh

Generous Limits: Don't rate-limit experimentation

Sandbox Implementation Patterns

Separate Endpoints

Production: api.example.com
Sandbox:    sandbox-api.example.com

Key Prefixes

Production key: sk_live_abc123...
Sandbox key:    sk_test_xyz789...

Environment Parameter

curl -X POST https://api.example.com/v1/messages \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"sandbox": true, ...}'

Sandbox Data

Pre-populated Test Data

// Sandbox comes with test users
const testUsers = await client.users.list();
// Returns: [
//   { id: "usr_test_alice", name: "Alice (Test)" },
//   { id: "usr_test_bob", name: "Bob (Test)" }
// ]

Magic Values

// Special values trigger specific behaviors
client.payments.create({
  amount: 1000,
  card: "4242424242424242"  // Always succeeds
});

client.payments.create({
  amount: 1000,
  card: "4000000000000002"  // Always declines
});

Documented Test Scenarios

## Test Card Numbers

| Number           | Behavior              |
|-----------------|----------------------|
| 4242424242424242 | Successful charge    |
| 4000000000000002 | Declined             |
| 4000000000009995 | Insufficient funds   |
| 4000000000000069 | Expired card         |

Interactive Documentation

Let developers make API calls without leaving the browser.

"Try It" Functionality

Essential Features:

  • Pre-authenticated (use their sandbox key automatically)
  • Pre-filled with working example data
  • Editable request parameters
  • Real API responses (not mocked)
  • Copy as cURL/code option

Implementation:

<div class="api-explorer">
  <h3>Try it: Send a Message</h3>

  <div class="request-editor">
    <label>To Phone Number</label>
    <input type="text" value="+15551234567" />

    <label>Message Body</label>
    <textarea>Hello from the API Explorer!</textarea>

    <button onclick="sendRequest()">Send Request</button>
  </div>

  <div class="response-viewer">
    <h4>Response</h4>
    <pre><code id="response"></code></pre>
  </div>
</div>

Interactive Docs Tools

OpenAPI-Based:

  • Swagger UI
  • Redoc
  • Stoplight Elements

Custom Platforms:

  • ReadMe.io
  • Postman Published Docs
  • Custom React components

Interactive Examples

Go beyond single requests:

## Interactive Tutorial: Send Your First Message

### Step 1: Check your balance
<api-explorer endpoint="GET /account/balance" />

### Step 2: Send a message
<api-explorer endpoint="POST /messages"
  body='{"to": "+15551234567", "body": "Hello!"}' />

### Step 3: Check message status
<api-explorer endpoint="GET /messages/{id}"
  params='{"id": "{{previous.id}}"}' />

Common Failure Points

Failure Point Analysis

Track where developers fail and why:

// Instrument error events
api.on('request_error', (error, request) => {
  analytics.track('api_error', {
    error_type: error.type,
    error_code: error.code,
    endpoint: request.endpoint,
    time_since_signup: timeSinceSignup(),
    is_first_call: isFirstCall()
  });
});

Most Common First-Call Failures

1. Authentication Errors (40% of first-call failures)

Problem: Wrong key, malformed header, missing auth
Fix:
- Clearer error messages: "API key should start with 'sk_test_'"
- Pre-filled code examples with actual key
- Auth header format shown with example

2. Request Format Errors (25%)

Problem: Wrong content type, malformed JSON, missing fields
Fix:
- Accept flexible content types on simple endpoints
- Return specific field-level errors
- Show exactly what was expected vs. received

3. Environment/Setup Errors (20%)

Problem: SDK not installed, wrong SDK version, missing dependencies
Fix:
- Version-specific installation instructions
- Compatibility matrix clearly visible
- Quick environment check script

4. Rate Limiting (10%)

Problem: Aggressive rate limits during exploration
Fix:
- Generous sandbox limits (or none)
- Clear rate limit errors with retry-after
- Don't count failed requests against limits

5. Networking Errors (5%)

Problem: Firewall, proxy, SSL issues
Fix:
- Connectivity test endpoint
- Clear networking troubleshooting guide
- Alternative ports/protocols if possible

Error Recovery Flows

Design error messages that recover the onboarding:

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key provided",
    "code": "invalid_api_key",
    "recovery": {
      "steps": [
        "Check that your API key starts with 'sk_test_' or 'sk_live_'",
        "Ensure there are no extra spaces or newlines",
        "Generate a new key at https://dashboard.example.com/keys"
      ],
      "docs": "https://docs.example.com/authentication",
      "support": "https://support.example.com/auth-issues"
    }
  }
}

The First-Call Experience Audit

Audit Checklist

Perform this audit quarterly (or after any onboarding changes):

As a New Developer:

  • Create a new account (use a fresh browser/incognito)
  • Time how long until you have a working API key
  • Follow the quickstart exactly as written
  • Make your first API call
  • Record total time and every friction point

Questions to Answer:

  • How many clicks from homepage to first API call?
  • How many pages/tabs did you need open?
  • What did you have to figure out that wasn't explained?
  • Where did you get stuck or confused?
  • What would have made you give up?

Friction Point Scoring

FrictionImpactPriority
Must verify email before API keyHighFix immediately
API key buried in settingsHighFix immediately
No copy button on code examplesMediumFix this quarter
Quickstart assumes specific OSMediumFix this quarter
Example uses outdated SDK versionLowFix when updating docs

Onboarding Optimization Framework

Step 1: Measure Current State

  • Instrument TTFAC tracking
  • Run first-call audit with 5 developers
  • Identify top 3 drop-off points

Step 2: Reduce Steps

  • Can any step be eliminated entirely?
  • Can any step be deferred until later?
  • Can multiple steps be combined?

Step 3: Accelerate Remaining Steps

  • Pre-fill everything possible
  • Provide copy buttons everywhere
  • Show progress and next steps

Step 4: Recover Failures

  • Improve error messages
  • Add inline troubleshooting
  • Provide live support for stuck developers

Step 5: Measure and Iterate

  • Track TTFAC improvements
  • A/B test onboarding changes
  • Regular audits with real developers

Tools

Onboarding Analytics

  • Amplitude/Mixpanel: Event tracking and funnels
  • FullStory/Hotjar: Session recording
  • Custom dashboards: TTFAC metrics

Interactive Docs

  • ReadMe.io: Full-featured developer hub
  • Stoplight: OpenAPI-powered docs
  • Redocly: API documentation platform
  • Custom: Build with React/Vue

Testing

  • Ghost Inspector: Automated onboarding testing
  • Checkly: API monitoring and testing
  • k6: Load testing of onboarding flows

Related Skills

  • docs-as-marketing: Quickstart documentation
  • sdk-dx: SDK that reduces onboarding complexity
  • developer-sandbox: The playground developers onboard with
  • developer-audience-context: Understanding your onboarding audience
  • developer-metrics: Measuring onboarding success

GitHub 저장소

jonathimer/devmarketing-skills
경로: skills/api-onboarding
0

연관 스킬

content-collections

메타

이 스킬은 콘텐츠 콜렉션(Content Collections)을 위한 프로덕션 검증된 설정을 제공합니다. 콘텐츠 콜렉션은 Markdown/MDX 파일을 Zod 검증이 포함된 타입 안전한 데이터 콜렉션으로 변환해주는 TypeScript 최우선 도구입니다. 블로그, 문서 사이트 또는 콘텐츠 중심의 Vite + React 애플리케이션을 구축할 때 타입 안전성과 자동 콘텐츠 검증을 보장하기 위해 사용하세요. Vite 플러그인 구성과 MDX 컴파일부터 배포 최적화 및 스키마 검증에 이르기까지 모든 것을 다룹니다.

스킬 보기

polymarket

메타

이 스킬은 개발자들이 Polymarket 예측 시장 플랫폼을 활용한 애플리케이션을 구축할 수 있도록 지원하며, 거래 및 시장 데이터를 위한 API 통합 기능을 포함합니다. 또한 WebSocket을 통한 실시간 데이터 스트리밍을 제공하여 실시간 거래와 시장 활동을 모니터링할 수 있습니다. 이를 통해 거래 전략을 구현하거나 실시간 시장 업데이트를 처리하는 도구를 생성하는 데 활용할 수 있습니다.

스킬 보기

creating-opencode-plugins

메타

이 스킬은 개발자들이 명령어, 파일, LSP 작업 등 25개 이상의 이벤트 유형에 연결되는 OpenCode 플러그인을 만들 수 있도록 돕습니다. JavaScript/TypeScript 모듈을 위한 플러그인 구조, 이벤트 API 명세, 구현 패턴을 제공합니다. OpenCode AI 어시스턴트의 라이프사이클을 사용자 정의 이벤트 기반 로직으로 가로채거나, 모니터링하거나, 확장해야 할 때 사용하세요.

스킬 보기

sglang

메타

SGLang은 RadixAttention 프리픽스 캐싱을 활용하여 JSON, 정규식, 에이전트 워크플로우를 위한 고속 구조화 생성에 특화된 고성능 LLM 서빙 프레임워크입니다. 특히 반복되는 프리픽스가 있는 작업에서 상당히 빠른 추론 속도를 제공하여 복잡한 구조화 출력 및 다중 턴 대화에 이상적입니다. 제약 디코딩이 필요하거나 광범위한 프리픽스 공유가 있는 애플리케이션을 구축할 때는 vLLM과 같은 대안보다 SGLang을 선택하십시오.

스킬 보기