Register Your App

Before you can interact with user data, you need to register your application and obtain API credentials.

Step 1: Create a Developer Account

1. Go to app.ofself.ai
2. Click "Developer Login"
3. Register with your email or sign in with an existing account

Step 2: Register Your Application

1. Navigate to Developer Dashboard
2. Click "Register New App"
3. Fill in your app details:

Field	Description	Example
App Name	Display name users will see	"My Note App"
Description	What your app does	"A smart note-taking app"
Redirect URI	OAuth callback URL	https://myapp.com/callback
Webhook URL	(Optional) Receive real-time events	https://myapp.com/webhook

4. Click "Register"

Step 3: Get Your Credentials

After registration, you'll receive:

┌────────────────────────────────────────────────────────────────┐
│  App Registered Successfully!                                   │
├────────────────────────────────────────────────────────────────┤
│                                                                 │
│  App ID:        app_a1b2c3d4e5f6                                │
│  Client ID:     ofs_client_xxxxxxxxxxxxx                        │
│  Client Secret: ofs_secret_xxxxxxxxxxxxx (shown once!)         │
│  API Key:       ofs_key_xxxxxxxxxxxxx                           │
│                                                                 │
│  ⚠️  Save these credentials securely!                           │
│                                                                 │
└────────────────────────────────────────────────────────────────┘

Save Your Secrets

The Client Secret is only shown once. Store it securely (environment variables, secret manager) - never in code.

Credential Types

Credential	Used For	How to Use
API Key	Server-to-server calls	X-API-Key header
Client ID/Secret	OAuth flow	Authorization code exchange

When to Use Each

• API Key: Backend services calling the OfSelf API
• OAuth: Web/mobile apps where users log in

Step 4: Configure Your Environment

Python

# .env file
OFSELF_API_KEY=ofs_key_xxxxxxxxxxxxx
OFSELF_CLIENT_ID=ofs_client_xxxxxxxxxxxxx
OFSELF_CLIENT_SECRET=ofs_secret_xxxxxxxxxxxxx

import os
from ofself import OfSelfClient

client = OfSelfClient(api_key=os.environ["OFSELF_API_KEY"])

JavaScript

# .env file
OFSELF_API_KEY=ofs_key_xxxxxxxxxxxxx

import { OfSelfClient } from '@ofself/sdk';

const client = new OfSelfClient({
  apiKey: process.env.OFSELF_API_KEY!
});

App Verification

New apps are in "Pending" status until verified by the OfSelf team. During this time:

• You can develop and test with your own user account
• Other users will see a warning before authorizing
• Some rate limits may apply

To request verification:

1. Go to Developer Dashboard
2. Click "Request Verification"
3. Provide app details and use case

Verified apps get:

• ✅ "Verified" badge shown to users
• ✅ Higher rate limits
• ✅ Access to production features

Next Steps

Now that you have credentials:

1. Set up authentication - Learn OAuth vs API Key
2. Make your first API call - Hello World tutorial