タクトモ / Apiの概要

タクトモ apiについて

公式URL http://developer.takutomo.com/
認証・制限など Apiキーを取得。開発初期は申請不要で開発用Apiキーが用意されている。
(2010/12/23時点)
概要 タクシーを呼んだり、相乗り相手を探す。

ここはなに?

タクトモの各種apiをコールしたときに、具体的にどんな値が返ってくるのか一瞬で分かります。
キーの意味を知るよりも、実際にどんな値が入っているかを知るほうが理解しやすいと思います。

目的の値を見つけて、あぁこの値を取り出すのはこのキーだな、とそんな使い方を想定しています。

使い方

このページの下にあるapiの一覧から目的っぽいページに移動しましょう。
パラメータをセットして、「call update」と書かれたボタンを押します。

百聞は一見にしかずです。 routeに移動し、「call update」を押してみてください。

V2

タクシーを呼ぶ(HTML)

タクシーを呼ぶためのURL。
タクトモの運用的な説明もあるのでドキュメント要確認。

タクシーを呼ぶ(QR)

パソコンサイトに表示するためのQRコードのURLです。
※ユーザーがパソコンで乗車地と目的地などを検索し、QR経由で携帯電話から申し込みを行う流れを想定していると思います。

タクシー台数を取得(API)

経度・緯度を指定して、付近のタクシーの台数を取得する。

相乗り募集リスト取得(API)

相乗り募集の状況の一覧を取得します。

※本APIをformat=xmlで取得する場合は注意が必要です。
※[call update]した後、result Treeではなく、「RAW data」をご確認ください。

相乗り募集詳細取得(API)

指定した相乗り情報の詳細を取得します。

相乗り募集リスト取得(HTML)

相乗り募集の状況の一覧ページのURL。

相乗り参加する(HTML)

相乗りに参加するためのページのURL。

会員情報の取得(API)

会員の詳細情報を取得します。

ユーザー情報(乗客向け)

会員が存在するか確認

ユーザーがタクトモに登録しているか確認する。

新規会員登録(guid)

携帯電話の端末IDを使って、新規ユーザー登録を行います。

新規会員登録(mail)

メールアドレスを使って、新規ユーザー登録を行います。
登録後、本人に登録確認メールが送信され、メールに記載されているURLにアクセスすることで登録が完了します。

メール登録できるドメイン

ユーザー登録に使用できるメールドメインの一覧を取得する。

プロフィール変更

ユーザーの登録内容を設定・変更します。

メールとパスワード変更

ユーザーのメールアドレス、パスワードを変更します。

パスワードを忘れた

ユーザーがパスワードを忘れたときの救済措置を用意します。
メールアドレスを入力して、パスワードが記載されたメールを送信します。

プロフィール取得(他ユーザー)

指定したユーザーのプロフィールの一覧を取得します。

プロフィール取得(自分)

自分自身(アクセス者?)のプロフィールの一覧を取得します。

評価を取得

指定したユーザーの過去の評価の一覧を取得します。

写真を削除

指定したユーザーのプロフィールに掲載している写真を削除。

退会する

指定したユーザーを退会させます。
※退会した場合、同じユーザーは再登録できませんので、実装の際はご注意ください。

タクシー検索(乗客向け)

タクシーを検索

タクシーの検索を行います。

タクシーを予約

タクシーの予約を行います。
成功すると、タクシー運転手の電話番号が返るので、乗客ユーザーに通知する。
タクトモのルールとして、予約成立直後に乗客自身がタクシードライバーに電話をかけることになっている。

予約中と予約したタクシー

予約中と、過去に予約したタクシーの情報を取得します。
※1~3ヶ月で古い予約データは消えていきます。

タクシーを評価

評価を投稿します。下記の3パターンがあります。
乗客がタクシー運転手を評価する場合。
タクシー運転手が乗客を評価する場合。
相乗り相手を評価する場合。

相乗り検索(乗客向け)

相乗り検索

タクシーの検索を行います。

相乗り募集の詳細を取得

相乗り募集の詳細データを取得。

相乗りに参加、キャンセル

相乗り案件に参加、または、キャンセルをする。
キャンセルは、募集を立てたユーザーはキャンセルできない。応募者はキャンセルできる。
募集主がキャンセルする場合は、その旨を自身の掲示板に書くことで対処するよう促す。

相乗り募集を立てる

新規で相乗り募集を作成する。
出発時間は、現在より10分以上未来を指定すること。

相乗り参加案件を取得

自分が参加中の相乗り募集内容を取得。
応募者や掲示板の内容など。

相乗り相手を評価

評価を投稿します。下記の3パターンがあります。
乗客がタクシー運転手を評価する場合。
タクシー運転手が乗客を評価する場合。
相乗り相手を評価する場合。

メッセージ(乗客向け)

他会員に直接メッセージ送信

他の会員にダイレクトにメッセージを送る。
第三者には見られないメッセージ。
乗客ユーザーと乗客ユーザーの間でのみやり取り可能。タクシー運転手は使えない。

届いた直接メッセージを取得

他の会員から送られてきたダイレクトにメッセージを確認する。
第三者には見られないメッセージ。
乗客ユーザーと乗客ユーザーの間でのみやり取り可能。タクシー運転手は使えない。

その他(乗客向け)

ワリカン電卓

相乗りしている最中に同乗者の負担額を計算する。
使い方や詳しい計算式などは公式ドキュメントを読んでください。

タクシー運転手向けAPI

会員が存在するか確認

ユーザーがタクシー運転手としてタクトモに登録しているか確認する。

自車位置を報告

経度緯度を指定して、自車の位置を登録します。

自車ステータス報告

自車の状態などを設定する。