Faça os dados Dexyd circularem sem refazer o trabalho duas vezes.

A API Dexyd permite que suas equipes encontrem concursos, envios, perfis, produtos Expo e exportações úteis em ferramentas internas, painéis de acompanhamento, CRM ou espaços de relatório.

AcessoInformações autorizadas acessíveis.

RelatóriosRelatórios mais fluidos.

EntradaMenos redigitação manual.

Concursos

Acompanhe seus challenges nos seus próprios painéis.

Envios

Aproxime as participações dos seus acompanhamentos operacionais.

Expo

Conecte os projetos visíveis às próximas ações comerciais.

Base

Começar com REST v1

Os endpoints públicos versionados ficam no mesmo domínio do aplicativo e retornam JSON previsível.

Base URL

https://www.dexyd.com/api/v1

Authentication

Authorization: Bearer <developer key>

The x-dexyd-api-key header is also accepted.

Format

application/json

Exports can also return text/csv.

Pagination

limit and offset

limit is clamped between 1 and 100.

Request

curl "https://www.dexyd.com/api/v1/competitions?limit=10" \
  -H "Authorization: Bearer dxyd_test_..." \
  -H "Accept: application/json"

Response

{
  "data": [],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 0
  }
}

Autenticação

Criar uma chave e enviá-la em cada solicitação

Chamadas REST autenticadas usam uma chave developer criada no console Dexyd. Envie pelo servidor e limite os escopos.

Criar uma chave

Abra o console developer no Dexyd, escolha o ambiente test ou live, nomeie a chave e copie-a ao criar.

Cabeçalho recomendado

Authorization: Bearer <chave developer>

Use em chamadas de servidor para endpoints REST e MCP.

Cabeçalho alternativo

x-dexyd-api-key: <chave developer>

Aceito quando a integração não pode usar Authorization.

Segurança

Nunca coloque uma chave live em navegador, app móvel ou repositório público; use seu backend.

Rotação

Revogue uma chave exposta no console e crie outra com os escopos úteis.

Cabeçalhos

Authorization: Bearer dxyd_live_...
x-dexyd-api-key: dxyd_live_...

Acesso

Escopos e ambientes

Chaves test são feitas para leituras públicas. Chaves live e escopos sensíveis dependem do plano ativado no console developer.

public:read

Read available public resources.

competitions:read

List public contests or organizer-owned contests with organizer=me.

submissions:read

Read submissions for a contest. Non-owners only see approved submissions.

expo:read

Read public Expo products or creator-owned products with mine=true.

exports:read

Export organizer contests as JSON or CSV.

media:import, agent:mcp, drafts:write

Advanced scopes for media imports, MCP and confirmable drafts.

Endpoints

Referência REST disponível

Cada linha mostra método, caminho, escopo esperado e parâmetros que alteram a resposta.

GET/api/v1/competitions

Lists public contests or organizer-owned contests.

public:read + competitions:read

Query: organizer=me, status, category, limit, offset.
Response: data[] and pagination.

GET/api/v1/submissions

Lists submissions for a contest.

submissions:read

Required query: competition_id.
Optional query: limit, offset.
Response: submissions with status, media, votes and dates.

GET/api/v1/expo-products

Lists visible Expo products or creator-owned products.

public:read + expo:read

Query: mine=true, q, category, limit, offset.
Response: products with category, stage, availability and media.

GET/api/v1/exports/competitions

Exports organizer contests.

exports:read

Query: format=json or format=csv.
Response: JSON or dexyd-competitions.csv.

Erros

Erros, limites e cabeçalhos

Os erros mantêm uma forma estável para decidir o que tentar novamente, corrigir ou escalar.

400

Missing or invalid parameter.

401

Missing, invalid, expired or revoked key.

402

Plan is insufficient for live or advanced access.

403

Scope is insufficient for the requested action.

404

Resource not found.

429

Minute or daily limit exceeded.

503

Developer storage is not configured yet.

Authenticated responses include X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.