Garoon APIドキュメント

CSRFトークンを取得する

目次

CSRFトークンを取得する

固定リンクがコピーされました

Garoonからセッション認証を使ってGaroon REST APIを実行するときに必要なCSRFトークンを取得します。

次のすべてに当てはまる場合には、CSRFトークンを付与してください。

CSRFトークンの使い方の詳細は、 Garoon CSRFトークンの利用例を確認してください。

関数

固定リンクがコピーされました

garoon.base.request.getRequestToken()

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 4.10以降

引数

固定リンクがコピーされました

なし

戻り値

固定リンクがコピーされました

型 説明
文字列 CSRFトークン
有効期間は最終アクセス時間から86,400秒（1日）です。

サンプルコード

固定リンクがコピーされました

ログイン名を指定して在席情報を更新するAPIを実行します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

const headers = {
  'X-Requested-With': 'XMLHttpRequest',
  'Content-Type': 'application/json',
};

// CSRFトークンを取得する
const csrfToken = await garoon.base.request.getRequestToken();
const body = {
  __REQUEST_TOKEN__: csrfToken,
  status: {
    code: 'attend'
  },
  notes: 'This is presence note.'
};
const params = {
  method: 'PATCH',
  headers,
  body: JSON.stringify(body),
};
const loginName = 'sato-noboru';

// 在席情報を更新するAPIを実行
const resp = await fetch(`/g/api/v1/presence/users/code/${loginName}`, params);
const respData = await resp.json();
console.log(respData);

利用できる画面

固定リンクがコピーされました

  • ポップアップ画面を除くすべての画面