Getting Started

Welcome to Yapture Market's developer documentation. Learn how to build, submit, and manage apps for the Yapture ecosystem.

Overview

Yapture Market is a platform for developers to distribute apps that enhance the Yapture task management experience. Our marketplace supports OAuth 2.0 integrations, allowing your app to securely access user data and provide powerful functionality.

What You Can Build

• Productivity Tools - Task automation, time tracking, focus timers
• Integrations - Connect Yapture with other services (Slack, GitHub, etc.)
• Analytics - Visualizations, reports, and insights on task data
• AI Tools - Smart suggestions, natural language processing, automation
• Custom Workflows - Specialized tools for specific industries or use cases

Prerequisites

• Yapture Account - Sign in with your Yapture credentials
• Developer Account - Register as a developer (free)
• Technical Skills - Familiarity with REST APIs and OAuth 2.0
• Web Hosting - Ability to host your app online (optional for some app types)

Step 1: Register as a Developer

Before you can submit apps, you need to register as a developer:

curl -X POST https://yapture.market/api/dev/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Your Name",
    "email": "developer@example.com",
    "yaptureUserId": "your-yapture-user-id",
    "companyName": "Your Company (optional)",
    "websiteUrl": "https://yourwebsite.com (optional)",
    "bio": "A brief bio about you or your company"
  }'

Note: You can find your Yapture User ID in your account settings.

Step 2: Generate an API Key

After registration, you'll need an API key to authenticate your requests. Generate one through the developer portal or programmatically:

curl -X POST https://yapture.market/api/dev/api-keys \
  -H "Authorization: Bearer YOUR_FIRST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API Key",
    "scopes": ["APP_CREATE", "APP_READ", "APP_UPDATE"],
    "expiresInDays": 365
  }'

Step 3: Create Your First App

Now you're ready to create an app listing:

curl -X POST https://yapture.market/api/dev/apps \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Awesome App",
    "description": "A short description of what your app does",
    "longDescription": "A detailed description with features, benefits, and use cases.",
    "category": "PRODUCTIVITY",
    "environment": "production",
    "logoUrl": "https://yourcdn.com/logo.png",
    "websiteUrl": "https://yourapp.com",
    "screenshots": [
      {
        "url": "https://yourcdn.com/screenshot1.png",
        "caption": "Main dashboard view",
        "order": 0
      }
    ]
  }'

Step 4: Submit for Review

Once your app is ready, submit it for review by our team. Apps are typically reviewed within 48 hours.

curl -X POST https://yapture.market/api/dev/apps/{APP_ID}/submit \
  -H "Authorization: Bearer YOUR_API_KEY"

Available App Categories

Next Steps

Support

Need help? Join our developer community on Discord or contact us at developers@yapture.com.