営業に問い合わせるログイン無料で始める
Developers
ガイド

Tooon Connect

自社サービスの会員に、Tooonの名刺・請求・契約などの機能を、自社の画面のまま提供するためのAPIです。

会員はTooonにログインしません。会員の業務は会員自身の事業として持ち、あなたの会社の業務とは混ざりません。

早期アクセス83のエンドポイント
早期アクセスを申し込む紹介ページ
データの持ち主
あなたのサービスのサーバー
├─ 通常のキー   → 自社のワークスペースの業務
└─ Connectのキー → 会員（externalId）
                    └─ 事業アカウント（accountId）
                         └─ 会員自身の顧客・案件・請求・契約

会員と事業アカウント

会員あなたのサービスの会員です。サービスの中で変わらないID（externalId）で指定します。Tooonのユーザーやメンバーにはなりません。
事業アカウント会員自身の事業です。1人の会員が複数持てます。顧客・案件・請求などはこの単位で持ちます。
名刺会員ごとに1枚。下書きを保存し、本人が確かめてから公開します。
あなたの会社の業務運営の業務は通常のキーで、自社のワークスペースとして扱います。会員の事業へ複製しません。

キーと権限

サイドバーの「コネクト」でサービスを始めると、そのサービス専用のコネクトワークスペースができます。キーは、そのワークスペースの「開発者」で管理者が発行し、そのサービスに固定されます。

Connectのキーでは通常の入口を、通常のキーではConnectの入口を呼べません。権限はconnect:で始まるものを、使う分だけ選びます。名刺用に発行したキーへ、あとから業務の権限が増えることはありません。

キーはサーバーの中だけで使いますキーがあれば、そのサービスの会員全員を扱えます。会員のブラウザやアプリには渡さないでください。
ヘッダー
Authorization: Bearer tooon_sk_…  # Connectのキー
Content-Type: application/json
Idempotency-Key: 9b2f6c1e-…  # 書き込みのとき

最初の呼び出し

  1. 会員を登録するログイン中の会員のexternalIdをサーバーで決めて送ります。名刺を作らない会員はcreateBusinessCard: falseを付けます。
  2. 事業アカウントを作る返ったidを保存します。以降の業務の入口では、これをaccountIdとして使います。
  3. 会員の業務を読み書きする/v1/connect/accounts/{accountId}/… の下に、顧客・案件・タスク・請求などの入口があります。
cURL
curl -X POST https://tooon.app/api/v1/connect/members \
  -H "Authorization: Bearer $TOOON_CONNECT_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6c1f0b9e-…" \
  -d '{ "externalId": "member-0001", "createBusinessCard": false }'

名刺を提供する

下書きの保存だけでは公開されません。本人に確かめてもらってから公開します。

  1. 会員を登録するnameを付けて登録すると、未公開の名刺ができます。公開URL用のpublicHandleも同時に取れます。
  2. 下書きを編集する名刺をGETし、返ったversionをexpectedVersionに入れてPATCHします。
  3. 公開する最新のversionで/publishを呼びます。止めるときは/unpublishです。
Connect 会員4

事業ユニットに紐づくサービスの外部会員。会員向けに発行した専用キーを使う

GET/v1/connect/membersPOST/v1/connect/membersPOST/v1/…/members/{externalId}/public-handle
Connect 事業アカウント5

外部会員の事業を運営会社と分けて管理する。作成だけで公開・決済・規約同意は行わない

GET/v1/connect/accountsGET/v1/…/accounts/{id}PATCH/v1/…/accounts/{id}
Connect 会員名刺5

外部会員の名刺を編集・公開する。下書きの保存と公開は別の操作

GET/v1/…/members/{externalId}/business-cardGET/v1/…/cards/{publicHandle}/publicPATCH/v1/…/members/{externalId}/business-card

会員の業務を扱う

自社の業務の入口と同じ形で、会員自身の事業を扱えます。

守ること

会員はサーバーで確かめるブラウザが送った会員IDやaccountIdをそのまま使わず、ログイン中の会員のものか確かめてから呼びます。
やり直しは同じキーで通信が切れたら、同じ本文と同じIdempotency-Keyで送り直します。別の操作には新しいキーを使います。
古い版では上書きしない更新にはGETで得た版（expectedVersion・expectedUpdatedAt）を付けます。違えば 409 を返すので、読み直して本人に確かめます。
退会は停止で伝える会員の退会には/deactivate、事業だけ止めるときは/disableを使います。データは消えず、業務の操作だけが止まります。

料金と申し込み

Tooon Connectの料金は、Tooonのプランとは別に決めます。いまは早期アクセスとして、申し込みいただいた事業者に個別にご案内しています。

早期アクセスを申し込む