車両、経費、リマインダー、フリートメンバー、アクティビティにプログラムからアクセスできます。Base URL: https://api.aufix.app。
概要
- All REST routes are under
/v1/…. - Successful responses use
{ "data": … }. - Errors use
{ "error": { "code": "…", "message": "…" } }. - Operational routes require an active Fleet plan (Fleet, Fleet Pro, or Fleet Max).
- Personal access tokens (PAT) are rate-limited; responses may include
Retry-After.
認証
| HTTP | リソース | 説明 |
|---|
| — | Authorization: Bearer … | 以下のすべてのルートにはパーソナルアクセストークンが必要です: Authorization: Bearer aufix_pat_…。キーの作成と無効化は「設定 → 連携」で行います(シークレットは一度だけ表示されます)。read — GET のみ、write — すべてのメソッド。 |
車両
| HTTP | リソース | 説明 |
|---|
| GET | /v1/vehicles | アクセス可能な車両を一覧取得します。クエリ: limit、カーソル after。 |
| POST | /v1/vehicles | ガレージに車両を作成します。 |
| GET | /v1/vehicles/:vehicleId | 車両を 1 件取得します。 |
| PATCH | /v1/vehicles/:vehicleId | 車両のフィールドを更新します。 |
| DELETE | /v1/vehicles/:vehicleId | 車両と関連レコードを削除します(オーナーのみ)。 |
車両の更新
| HTTP | リソース | 説明 |
|---|
| GET | /v1/vehicles/:vehicleId/updates | 状態の更新(走行距離、燃料/充電、コンディション、タイヤ、コメント)を一覧取得します。クエリ: limit、afterId + afterAt。 |
| POST | /v1/vehicles/:vehicleId/updates | 車両の新しい更新を記録します。 |
経費
| HTTP | リソース | 説明 |
|---|
| GET | /v1/expenses | 経費を新しい順に一覧取得します。クエリ: limit、vehicleId、カーソル afterId + afterValue。 |
| POST | /v1/expenses | 車両に紐づく経費、または車両に紐づかない個人の経費を作成します。 |
| PATCH | /v1/expenses/:expenseId | 経費を更新します。 |
| DELETE | /v1/expenses/:expenseId | 経費を削除します。 |
リマインダー
| HTTP | リソース | 説明 |
|---|
| GET | /v1/reminders | リマインダーを期限順に一覧取得します。クエリ: limit、vehicleId、カーソル afterId + afterValue。 |
| POST | /v1/reminders | 車両に紐づくリマインダー、または個人用のリマインダーを作成します。 |
| PATCH | /v1/reminders/:reminderId | リマインダーのフィールドを更新します(対応している場合は完了状態も含みます)。 |
| DELETE | /v1/reminders/:reminderId | リマインダーを削除します。 |
アクティビティ
| HTTP | リソース | 説明 |
|---|
| GET | /v1/activity | フリートオーナーのアクティビティ履歴です。クエリ: limit、カーソル afterId + afterAt。 |
フリート
| HTTP | リソース | 説明 |
|---|
| GET | /v1/fleet/members | フリートメンバー、ロール、車両の割り当てを一覧取得します。 |
| GET | /v1/fleet/invites | フリート招待の一覧を取得します。返されるフィールド: inviteId, email, role, status, acceptedBy, expiresAt, createdAt, updatedAt, isExpired. |