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リファレンス

https://developers.karte.io/reference/karte-api-client