コンテンツにスキップ

検索はプロダクションビルドでのみ利用可能です。 ローカルでテストするには、サイトをビルドしてプレビューしてください。

API仕様 概要

Speakeasy の全サービス間通信は Cloudflare Workers Native RPC を使用しています。従来の REST API は存在せず、TypeScript メソッドを Service Binding 経由で直接呼び出します。


ブラウザ (Svelte 5)
↓ Remote Function
SvelteKit Server (*.remote.ts)
↓ platform.env.{SERVICE}.methodName(params)
WorkerEntrypoint (各サービス)
↓ ビジネスロジック
PostgreSQL / KV / R2 / Queues / Durable Objects
apps/counter/src/lib/chat.remote.ts
import { query } from '$app/server';
import { z } from 'zod';
import { getFizzClient } from './fizz-rpc';
export const getChatRooms = query(z.object({ limit: z.number().optional() }), async ({ limit }) => {
const client = getFizzClient();
return client.listChatRooms({
shopId: getShopId(),
userId: getUserId(),
userType: 'shop',
limit
});
});

詳細は Native RPC & Service Bindings を参照してください。


サービスメソッド数主な機能領域ドキュメント
Fizz23チャット・一括配信・WebSocketFizz RPC
Vintage37連絡先・グループ・ラベル・ブラックリストVintage RPC
Proof20認証・セッション・組織・ユーザーProof RPC
Bell31通知設定・PUSH・メール・LINEBell RPC
Base30アカウント・組織・店舗・LINE 連携Base RPC

外部サービス向けの Public API は Tap ゲートウェイ(tap.plfumg.com)が提供しています。

詳細な API リファレンスは Scalar API Reference として公開されています:


カーソルベースのページネーションを使用します。

// リクエスト
{ cursor?: string; limit?: number }
// レスポンス
{
items: readonly Item[];
nextCursor: string | null;
hasMore: boolean;
}

全メソッドは Promise を返却します。エラー時は例外がスローされます(Native RPC の制約)。

多くのメソッドは cookie パラメータを受け取り、内部でセッション検証を行います。Service Binding 経由の呼び出しでは、呼び出し元がセッション情報を取得済みであることを前提とします。