メインコンテンツへスキップ

APIでデータを取得することはできますか？(APIの利用手順解説)

  • 更新

概要

このページでは Cariotサーバーに蓄積されている情報をAPIで取得する方法を解説します。

API_____1.png

Salesforce環境に蓄積されているデータを API で取得する方法は Salesforce API の仕様書をご参照ください。
https://trailhead.salesforce.com/en/content/learn/modules/api_basics

 

目次
Cariot API の使用準備 (アクセスキーの取得)
Cariot APIの仕様
APIの利用例1: ユーザー認証を行いAPIトークンを取得
APIの利用例2: 登録済みデバイス情報の取得
APIの利用例3: 車両(デバイス)ごとのセンサデータ(送信ログデータ)の取得
APIの利用例4: 車両（デバイス）のリアルタイム位置情報取得
APIの利用に関する補足情報

 

Cariot API の使用準備 (アクセスキーの取得)

以下の手順で APIアクセスキー、APIアクセスシークレットを取得してください。

  1. https://app.cariot.jp/auth/salesforce にアクセス

  2. [Production/Dev]をクリック

  3. 上部メニューの[APIアクセス情報]タブをクリック

ここで表示される APIアクセスキー、APIアクセスシークレットはお客様ごとのユニークな認証情報であるため、公開しないようにしてください。

API_____2.png

API_____3.png

API_____4.png

 

Cariot APIの仕様

Cariot API の仕様は以下で公開しています。
https://api-doc.cariot.jp/

上記ページでは全APIのリクエスト・レスポンスの仕様を公開しています。
また、Webブラウザから直接APIを実行することも可能です。

 

APIの利用例1: ユーザー認証を行いAPIトークンを取得

1． ユーザー認証を行いAPIトークンを取得する

https://api-doc.cariot.jp/#!/Authentication/post_api_login

  • Cariotから発行されたAPIアクセスキー、APIアクセスシークレットを用いてAPIトークンを取得します。
  • APIトークンは他のAPIを実行する時の認証情報として必要になります。
  • APIトークンは有効期限が設定されていますが、有効期間はトライアル期間よりも十分に長く設定されています。
  • APIの使い勝手を評価する目的の場合は、手動で実行し、APIトークンのみシステムに保持する形もお勧めです。

2． Salesforceのログインページに遷移するため、Cariot管理者のユーザ名・パスワードでログインしてください。(既にログイン済みの場合この画面は表示されません。手順3．に進んでください)

3． 「アクセスを許可しますか?」という画面が表示されたら、[許可]をクリックしてください。

4． 「APIアクセス情報」というタブをクリックすると、APIアクセスキー・APIアクセスシークレットが表示されます。

  • こちらの画面はAPIユーザの設定画面で、APIトークン取得時には入力不要の画面となります。何も入力せず、「APIアクセス情報」タブをご参照ください。

 

APIの利用例2: 登録済みデバイス情報の取得

仕様解説ページ
https://api-doc.cariot.jp/#!/Device/get_api_devices

契約されているデバイス情報を一覧で取得します。
HTTPヘッダ「x-auth-token」に1.で取得したAPIトークンを指定してください。

 

APIの利用例3: 車両(デバイス)ごとのセンサデータ(送信ログデータ)の取得

仕様解説ページ
https://api-doc.cariot.jp/#!/Event/get_api_events_device_sn
指定した期間における車両（デバイス）のデータを取得します。
HTTPヘッダ「x-auth-token」に1.で取得したAPIトークンを指定してください。

(例) 以下のデータを取得する場合
- device_snが「12345」
- 期間が2017/09/05一日分(2017/09/05 00:00:00.000〜2017/09/05 23:59:59.999)
- 時刻の古い順
- 最大取得件数100000(指定できるMAXは100000)

リクエストURL(パス)は以下のようになります。
/api/events/?start=1504537200000&end=1504623599999&limit=100000&order=asc

 

APIの利用例4: 車両（デバイス）のリアルタイム位置情報取得

仕様解説ページ
https://api-doc.cariot.jp/#!/Device/get_api_devices
(利用例3と同様で、リクエストパラメータのみ異なります)

デバイスの現在(最新)位置情報を取得します。リアルタイムでデバイスの位置情報を表示する時に使用します。

HTTPヘッダ「x-auth-token」に1.で取得したAPIトークンを指定してください。
レスポンスのitems/latitude,longitudeで現在(最新)位置情報が取得できます。
なお、一度も走行のない（データの送信がない）デバイスの場合はitems/last_update_mills=0となります。呼び出した時点における最新の位置情報を返します。

(例） 以下のデータを取得する場合
- device_snが「12345」「67890」の2台
- フィールドを全て

リクエストURL（パス）は以下のようになります。
/api/devices?fields=all&device_sn=12345,67890

 

APIの利用に関する補足情報

APIの利用に関して、一時的な評価目的で使用する場合は追加費用は発生いたしません。本運用でご利用になる場合については、使用頻度や呼び出し回数を確認させていただいた上で、1日あたりの呼び出し回数に制限を設けさせていただいたり、有償での提供とさせていただくことがございます。弊社営業担当またはCariotカスタマーサポートまでお問い合わせください。

関連記事

Powered by Zendesk