Documentação para Parceiros

DevScout Partner API

Esta documentação descreve como integrar sua plataforma com a DevScout para verificar, em tempo real, se um usuário é assinante ativo, permitindo que você conceda descontos e benefícios exclusivos de forma automática e segura.

REST APIJSONRate limit: 60 req/min

Como funciona

Cada assinante DevScout possui um código de verificação único (UUID) visível no seu painel. O fluxo de verificação é:

  1. 1O usuário acessa sua plataforma e informa o código de verificação DevScout dele.
  2. 2Sua plataforma chama nosso endpoint GET /api/verify/subscriber enviando o código + sua API Key no header.
  3. 3Recebemos a resposta: se é assinante ativo, qual plano e até quando.
  4. 4Sua plataforma concede o desconto ou benefício correspondente.

Autenticação

Toda requisição deve incluir sua API Key de parceiro no header X-Partner-Key. A chave é fornecida pela equipe DevScout após o cadastro da sua plataforma como parceira.

http header
X-Partner-Key: sua_api_key_aqui

Nunca exponha sua API Key no front-end. Sempre faça a chamada a partir do seu servidor (server-side) para proteger a chave.

Endpoint de Verificação

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

Query Parameters

codeO código de verificação UUID do usuário (obrigatório)

Headers

X-Partner-KeySua API Key de parceiro (obrigatório)

Exemplos de Requisição

curl
curl -X GET \
  "https://api.devscout.app/api/verify/subscriber?code=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-Partner-Key: sua_api_key_aqui"
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) {
  // Conceder desconto
  console.log('Plano:', data.plan_name);
  console.log('Válido até:', data.valid_until);
} else {
  console.log('Usuário não é assinante ativo');
}
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"Plano: {data['plan_name']}")
    print(f"Válido até: {data['valid_until']}")

Resposta

Assinante ativo

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"
}

Não assinante (plano free)

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

Código inválido ou API Key inválida

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

Campos da resposta

success·boolean

true se a requisição foi processada com sucesso

is_subscriber·boolean

true se o usuário possui assinatura ativa (não free)

plan_slug·string

Identificador do plano: scout-free, scout-explorer, scout-master

plan_name·string

Nome legível do plano

valid_until·string | null

Data ISO de expiração da assinatura

user_name·string

Nome de usuário DevScout (para confirmação)

Limites e Boas Práticas

Rate limit

60 requisições por minuto por API Key. Implemente cache de curta duração (ex: 5 minutos) para evitar chamadas desnecessárias.

Nunca exponha a API Key

Faça a chamada sempre server-side (backend). Nunca no front-end ou em apps mobile.

Valide o user_name

Para segurança extra, peça ao usuário para confirmar o username DevScout dele e compare com o user_name retornado.

Trate erros graciosamente

Se nossa API estiver indisponível (HTTP 5xx), considere permitir o acesso temporariamente e tentar novamente mais tarde.

Tornar-se Parceiro

Interessado em oferecer benefícios exclusivos para os assinantes DevScout? Entre em contato com nossa equipe para obter sua API Key e ser listado no painel de parceiros.

Entrar em Contato
    Documentação para Parceiros | DevScout