---
title: 'REST API'
description: トークン、Bearerアクセス、リクエスト例、OpenAPIリファレンスへのリンク。
type: doc
locale: ja
canonical: 'https://yoseno.com/ja/docs/integrations/rest-api'
updated: '2026-07-30'
---

# REST API

トークン、Bearerアクセス、リクエスト例、OpenAPIリファレンスへのリンク。

REST APIは `/api/v1` 配下で利用でき、スクリプト、内部サービス、CI、データの書き出し、その他のサーバー側自動化に適しています。

保護されたエンドポイントには、個人用APIトークンが必要です。リクエストは、トークンを発行したユーザーとして実行され、同じ役割と権限のチェックを受けます。

## 認証

トークンはHTTPヘッダーで次のように送信します：

```http
Authorization: Bearer <token>
```

トークンの発行、保存、失効の方法については、[APIトークン](https://yoseno.com/ja/docs/integrations/api-tokens.md)の記事を参照してください。

## リクエスト例

```bash
curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"
```

`{org}`を組織IDに置き換えてください。特定のエンドポイントのパラメータ、レスポンス形式、エラーコードについては、完全な仕様を参照してください。

## リクエスト制限

APIには過負荷を防ぐためのレート制限が設けられています。
- 認証済みアプリケーションAPI：ユーザーまたはIPごとに毎分300リクエストです。
- 決済プロバイダーのWebhook：毎分600リクエストです。
- 公開エンドポイント（`/status`、ナレッジベースのカード）：IPごとに毎分300リクエストです。

制限を超えると、サーバーはHTTP `429 Too Many Requests` を返します。レスポンスには `Retry-After` ヘッダー（再試行までの秒数）と次のエラーボディが含まれます。

```json
{
  "status": 429,
  "message": "リクエストが多すぎます。30秒後にもう一度お試しください。",
  "errors": {}
}
```

## 完全なドキュメント

- [OpenAPI reference](https://yoseno.com/docs/api)：エンドポイント、パラメータ、レスポンススキーマのインタラクティブなドキュメントです。
- [OpenAPI JSON](https://yoseno.com/docs/api.json)：クライアントジェネレーター、Postman、Insomnia、コントラクト検証向けの機械可読スキーマです。

## 関連ページ

- [/docs/api](https://yoseno.com/docs/api)
- [/docs/api.json](https://yoseno.com/docs/api.json)
- [APIトークン](https://yoseno.com/ja/docs/integrations/api-tokens.md) — パーソナルトークンと \`/api/v1\` へのベアラーアクセス。

## 続きを読む

- [ナレッジベースについて](https://yoseno.com/ja/docs/knowledge.md) — プラクティスのカタログと、プラットフォームの推奨事項との関連を説明します。