同じ作業を二度行わずに Dexyd データを流通させます。

Dexyd API により、チームはコンテスト、提出物、プロフィール、Expo 製品、エクスポートを社内ツール、追跡ダッシュボード、CRM、レポート空間で利用できます。

アクセス許可された情報を利用できます。

レポートレポート作成がより滑らかになります。

入力手作業の再入力を減らします。

コンテスト

自社のダッシュボードでチャレンジを追跡します。

提出物

参加内容を運用上の追跡に近づけます。

Expo

公開プロジェクトを商談や次の対応につなげます。

基本

REST v1を始める

バージョン付き公開エンドポイントはアプリと同じドメイン配下にあり、予測しやすいJSONを返します。

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

認証

キーを作成し、各リクエストで送信する

認証済みREST呼び出しはDexydコンソールで作成した開発者キーを使います。サーバーから送信し、必要なスコープに限定してください。

キーを作成

Dexydの開発者コンソールを開き、testまたはlive環境を選び、キー名を付けて作成時にコピーします。

推奨ヘッダー

Authorization: Bearer <developer key>

RESTとMCPエンドポイントへのサーバー呼び出しで使います。

代替ヘッダー

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

Authorizationを使えない統合向けに受け付けます。

セキュリティ

liveキーをブラウザ、モバイルアプリ、公開リポジトリに置かず、バックエンド経由で呼び出してください。

ローテーション

露出したキーはコンソールで失効し、必要なスコープで新しいキーを作成します。

ヘッダー

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

アクセス

スコープと環境

testキーは公開読み取り向けです。liveキーと機密スコープはコンソールで有効なプランに依存します。

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.

エンドポイント

利用可能なRESTリファレンス

各行にメソッド、パス、必要なスコープ、レスポンスを変えるパラメータを示します。

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.

エラー

エラー、制限、ヘッダー

エラー形式は安定しているため、再試行、修正、エスカレーションを判断できます。

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.