karteApiClientForCraftTypeApp
このmoduleを使うためにはGrowthプラン以上の契約が必要です
karteApiClientForCraftTypeApp
はCraft TypeのAppを使ってKARTEのAPI v2を実行するためのクライアントライブラリです。 API Reference のNode.js Exampleで利用している api モジュールのラッパーとして動作します。
使い方
使い方は以下の通りです。
karteApiClientForCraftTypeApp()
でクライアントを取得します。 karteApiClientForCraftTypeApp()
の引数は次のとおりです。
karteApiClientForCraftTypeApp({
token: '{{ ACCESS_TOKEN }}',
specUri: '@dev-karte/v1.0#xxxxxxxxxx'
})
token
にはAPI v2 Appのアクセストークンを指定します。 specUri
にはリファレンスの Node.js Example にある require('api')
の引数 (@dev-karte/v1.0#
から始まる文字列) を指定します。
以下はINSIGHT APIクライアントを作成するコードの例です:
// ACCESS_TOKEN には API v2 Appのアクセストークンを指定します。
const token = 'ACCESS_TOKEN';
// INSIGHTのclientを作成します。
// 最新のspecUriはAPI v2のリファレンスを参照してください。
const insight = karteApiClientForCraftTypeApp({
token,
specUri: '@dev-karte/v1.0#3htrzx1mlidx35yh',
});
- API v2 Appの作成方法は アプリを利用する をご確認ください。
- 各APIに対応するメソッドはAPI ReferenceのNode.js Exampleを参照してください。
Example
/v2/talk/message/sendFromOperator APIを呼び出して、TALKのメッセージをログに出力します。
export default async function (data, {MODULES}) {
const {initLogger, karteApiClientForCraftTypeApp} = MODULES;
const logger = initLogger({ logLevel: 'DEBUG' })
// {{ ACCESS_TOKEN }} にAppのトークンを入れる
// トークンを取り回す際はSecret Managerの利用を推奨します。
const talk = karteApiClientForCraftTypeApp({
token : '{{ACCESS_TOKEN}}',
specUri: '@dev-karte/v1.0#d9ni28lia2r0hf'
});
try {
const res = await talk.postV2TalkMessageGet(
{options: {limit: 1},
user_id: 'visitor_id_hogehoge'
});
logger.log(res);
} catch (e) {
logger.error(e);
}
}
APIリファレンス
Updated 8 months ago