DevScout

Partner Documentation

DevScout Partner API

This documentation describes how to integrate your platform with DevScout to check, in real time, whether a user is an active subscriber, allowing you to grant exclusive discounts and benefits automatically and securely.

REST APIJSONRate limit: 60 req/min

How it works

Every DevScout subscriber has a unique verification code (UUID) visible in their dashboard. The verification flow is:

  1. 1The user visits your platform and provides their DevScout verification code.
  2. 2Your platform calls our GET /api/verify/subscriber endpoint sending the code + your API Key in the header.
  3. 3You receive the response: whether they are an active subscriber, which plan, and until when.
  4. 4Your platform grants the corresponding discount or benefit.

Authentication

Every request must include your partner API Key in the X-Partner-Key header. The key is provided by the DevScout team after your platform is registered as a partner.

http header
X-Partner-Key: your_api_key_here

Never expose your API Key on the front-end. Always make the call from your server (server-side) to protect the key.

Verification Endpoint

GEThttps://api.devscout.app/api/verify/subscriber

Query Parameters

codeThe user's UUID verification code (required)

Headers

X-Partner-KeyYour partner API Key (required)

Request Examples

curl
curl -X GET \
  "https://api.devscout.app/api/verify/subscriber?code=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-Partner-Key: your_api_key_here"
javascript (Node.js)
const response = await fetch(
  'https://api.devscout.app/api/verify/subscriber?code=' + userCode,
  {
    headers: {
      'X-Partner-Key': process.env.DEVSCOUT_PARTNER_KEY,
    },
  }
);

const data = await response.json();

if (data.is_subscriber) {
  // Grant the discount
  console.log('Plan:', data.plan_name);
  console.log('Valid until:', data.valid_until);
} else {
  console.log('User is not an active subscriber');
}
python
import requests
import os

response = requests.get(
    'https://api.devscout.app/api/verify/subscriber',
    params={'code': user_code},
    headers={'X-Partner-Key': os.getenv('DEVSCOUT_PARTNER_KEY')}
)

data = response.json()

if data.get('is_subscriber'):
    print(f"Plan: {data['plan_name']}")
    print(f"Valid until: {data['valid_until']}")

Response

Active subscriber

json (HTTP 200)
{
  "success": true,
  "is_subscriber": true,
  "plan_slug": "scout-master",
  "plan_name": "Scout Master",
  "valid_until": "2025-06-01T00:00:00",
  "user_name": "joao_dev"
}

Not a subscriber (free plan)

json (HTTP 200)
{
  "success": true,
  "is_subscriber": false,
  "plan_slug": "scout-free",
  "plan_name": "Scout Free",
  "valid_until": null,
  "user_name": "joao_dev"
}

Invalid code or invalid API Key

json (HTTP 401)
{
  "success": false,
  "is_subscriber": false,
  "error": "Invalid verification code or partner key"
}

Response fields

success·boolean

true if the request was processed successfully

is_subscriber·boolean

true if the user has an active subscription (not free)

plan_slug·string

Plan identifier: scout-free, scout-explorer, scout-master

plan_name·string

Human-readable plan name

valid_until·string | null

ISO date when the subscription expires

user_name·string

DevScout username (for confirmation)

Limits and Best Practices

Rate limit

60 requests per minute per API Key. Implement short-lived caching (e.g. 5 minutes) to avoid unnecessary calls.

Never expose the API Key

Always make the call server-side (backend). Never on the front-end or in mobile apps.

Validate the user_name

For extra security, ask the user to confirm their DevScout username and compare it with the returned user_name.

Handle errors gracefully

If our API is unavailable (HTTP 5xx), consider allowing access temporarily and retrying later.

Become a Partner

Interested in offering exclusive benefits to DevScout subscribers? Contact our team to get your API Key and be listed in the partners dashboard.

Get in Touch