WebAPIを使う - aktnk/til GitHub Wiki

  • TimeTaggerサーバはWebAPIを使用することで、タスク情報を登録したり、登録したデータの取得が可能
  • WebAPIを使用するには、ユーザに対して提供されるAPI tokenを利用する必要あり

API tokenを取得する

  1. API tokenを取得したいユーザでTimeTaggerサーバにログインした後、左上のハンバーガーアイコンをクリック、表示されたメニューから[Account]を選択する account_menu
  2. Accountページに現状のLoginユーザ名、そのユーザのAPI tokenが表示されるので、[コピー]アイコンをクリックし、API tokenの文字列を保存す account_apitoken

登録済みのデータを取得する

  1. Ubuntuのコマンドラインから、curlコマンドを入力し、指定されたタイムスタンプ間の登録データを取得する 
    curl --header "authtoken:(API token)" http://localhost:8080/api/v2/records?timerange=(開始日時のタイムスタンプ)-(終了日時のタイムスタンプ)
    なお、下記では curlコマンドの出力をjqコマンドへパイプで渡し、戻り値のJSONを整形して表示させている 
    (venv310) $ curl --header "authtoken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXIxIiwiZXhwaXJlcyI6MzI1MDM3NDg0MDAsInNlZWQiOiI0R2FLdldjYUxFTSJ9.G21SQp-xOhIJyk6K5Pl2gvbkSdeDwAyIrlh3XLQh580" http://localhost:8080/timetagger/api/v2/records?timerange=1729598453-1730598453 | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   128  100   128    0     0  16000      0 --:--:-- --:--:-- --:--:-- 18285
{
  "records": [
    {
      "key": "dgzKOROV",
      "mt": 1730596631,
      "t1": 1730592900,
      "t2": 1730596631,
      "ds": "#mtg",
      "st": 1730596634.6743703
    }
  ]
}
(venv310) $
    (値の確認)
    • ハンバーグアイコンをクリックし表示されたメニューから[Export all records]を選択すると、現在登録されているデータが表示される ここに表示されているデータが、先にWebAPIで取得したデータを一致していることが確認できた now_datas_unix