Tooon API

業務データを、自分のシステムにつなぐ。

取引先、プロジェクト、タスク、パートナー、会社の人と名刺。Tooonの業務データを、自社サイトや社内のツールから読み書きできる公式APIです。自分のサービスの会員にTooonの機能を届けるTooon Connectも、このAPIの中にあります。

Solo以上のプランで使えます。

つなげるもの

Tooonの業務データを、そのまま。

どれも、Tooonの画面で見ているのと同じデータです。

  • 取引先

    一覧・検索、登録、情報や状態の変更。自社のIDを付けて重複なく登録できる。

  • プロジェクト

    作成、内容・状態・親子関係の変更、一覧と検索。

  • タスク

    作成、内容・担当・期日・状態の変更。担当にできる人の一覧も取れる。

  • パートナーと業務委託契約

    外注先と契約の登録・更新。請求書作成依頼の下書きと送付。

  • 会社の人とメンバーカード

    社員・業務委託のスタッフの登録と、名刺の作成・更新・公開。

  • 会社カード

    公開中の紹介・提供メニュー・実績を読み取って、自社サイトに出す。

キー

権限を選んで、キーを発行する。

管理者が「設定 → 連携 → APIキー」から、名前と権限を選んで発行します。問い合わせフォーム用には取引先だけ、社内ツール用にはタスクだけ。用途ごとにキーを分けて、いつでも止められます。

Solo以上
安全に

人が決めることは、画面に残す。

請求の承認と支払い、メンバーの招待や権限の変更は、どの権限を付けてもAPIからはできません。自動で回すところと、人が確かめるところを、Tooonが分けています。

活用例

こんなアプリなら、Tooonがよく合う。

画面と体験は自分でつくり、取引先・契約・請求・名刺のような業務の仕組みはTooonに任せる。表と裏をこう分けると、つくるものがぐっと少なくなります。

  • 業務委託・フリーランスと働くチーム

    外部の人との契約と請求を、自社の仕組みで回したい

    表(あなたのアプリ)
    募集・登録フォーム、スタッフ向けポータル
    裏側(Tooon)
    パートナーと業務委託契約の登録、請求書作成依頼の下書きと送付
    partnersinvoice_requests
  • 制作会社・士業の顧客ポータル

    お客さんに、案件の進み具合を自社の画面で見せたい

    表(あなたのアプリ)
    顧客がログインするポータル、進捗の表示
    裏側(Tooon)
    取引先ごとのプロジェクトとタスク、担当と期日
    clientsprojectstasks
  • 問い合わせ・予約フォーム

    届いた問い合わせを、そのまま仕事にしたい

    表(あなたのアプリ)
    問い合わせフォーム、予約ページ、チャット
    裏側(Tooon)
    取引先の登録、対応タスクの作成
    clientstasks
  • コーポレートサイト・採用サイト

    サイトに出す実績とメンバーを、二重に更新したくない

    表(あなたのアプリ)
    自社サイトのデザインと記事
    裏側(Tooon)
    会社カードの提供メニュー・実績、会社の人と名刺
    company_pagepeoplebusiness_cards
  • 人事・社内ポータル

    入社や異動のたびに、名刺と名簿を手で直したくない

    表(あなたのアプリ)
    人事システム、社内ポータル
    裏側(Tooon)
    会社の人の登録・更新、名刺の作成と公開
    peoplebusiness_cards
  • 経費・精算のアプリ

    立て替えた経費を、自社のフォームから申請してもらいたい

    表(あなたのアプリ)
    経費の申請フォーム、領収書の撮影
    裏側(Tooon)
    経費の登録と領収書の添付、精算までの状態
    expensessettlements
Tooon Connect

会員向けのサービスも、Tooonの上で。

Tooon Connectは、Tooon APIの中の、自社サービスの会員にTooonの機能を届けるための仕組みです。会員はあなたのサービスにログインしたまま、デジタル名刺や自分の事業の業務を使えます。いまは早期アクセスを受け付けています。

Tooon Connectを見る
組み込みやすさ

つなぎ込みで困らないように。

どの操作でも同じ決まりで動きます。詳しくは仕様書にあります。

  • やり直しても二重にならない

    書き込みに Idempotency-Key を付ければ、通信が切れて同じ値で送り直しても、1回目と同じ結果が返ります。

  • 自社のIDでつなぐ

    externalRef を付けて登録すると、同じ値で何度呼んでも1件のまま。自社のデータと対応を取りやすい。

  • キーごとの権限

    読むだけ・書き込みまでを機能ごとに選べます。権限の外の操作は、理由つきのエラーで返ります。

  • 1分60回まで

    キーごとの上限です。残りの回数はレスポンスのヘッダーで分かります。

  • サーバーから使う

    キーは発行したときに一度だけ表示され、Tooonには元の値を残しません。

  • 仕様は公開の定義から

    仕様書は、APIそのものの定義から作られています。OpenAPIの定義も公開しています。

始め方

3つの手順で、つながる。

  1. 1Solo以上のプランにする

    APIは、Solo・Pro・Businessのワークスペースで使えます。

  2. 2APIキーを発行する

    管理者が「設定 → 連携」で、名前と権限を選んで発行。キーはサーバーの環境変数に。

  3. 3仕様書どおりに呼ぶ

    まずは GET /api/v1/me で、キーとワークスペースを確かめるところから。

Tooonを、自社の仕組みの一部に。

Solo以上のプランで、APIキーを発行してすぐに使えます。