How to Connect Your Apps to Our Service

This guide explains how to connect your applications to our service.

First Things First: Getting Connected

Before you can use our service, you'll need to get a special access key (we call it a "token"). Think of it like a password that lets your app talk to our service.

How to Get Your Access Key

Send your email and password to this address: POST /api/auth

What to Send

{
    "email": "you@example.com",
    "password": "your_password"
}

Example Request

curl -X POST https://stokestse.com/api/auth \
    -H "Content-Type: application/json" \
    -d '{"email": "you@example.com", "password": "your_password"}'

What You'll Get Back

We'll send you your access key and some basic information about your account:

{
    "success": true,
    "token": "your.access.key",
    "user": {
        "id": "your_id",
        "email": "you@example.com",
        "username": "your_name"
    }
}

Using Your Token

For all subsequent API requests, include your token in the Authorization header as a Bearer token:

Authorization: Bearer your.access.key

What You Can Do With Our Service

See Your Organizations

Want to see all the organizations you're part of? Just ask: GET /api/orgs

Example Request

curl https://stokestse.com/api/orgs \
    -H "Authorization: Bearer your.access.key"

We'll show you something like this:

{
    "success": true,
    "organizations": [
        {
            "id": "org_123",
            "name": "My Family Links",
            "is_owner": true,
            "member_count": 5
        }
    ]
}

If Something Goes Wrong

If there's a problem, we'll let you know what happened and how to fix it:

{
    "success": false,
    "message": "Here's what went wrong..."
}

Common Issues You Might See

  • 400 - You forgot to include some information we need
  • 401 - Your access key is missing or doesn't work anymore
  • 403 - You're not allowed to see this information
  • 404 - We couldn't find what you were looking for