Closed2023/05/08にクローズ15

zendeskアプリ開発

zendesk

Takaaki Kakei

エージェント画面のコンテキストパネルにブックマーク機能をつけたい

コンテキストパネル

Takaaki Kakei

Zendesk アプリ開発の参考

Takaaki Kakei

(共通)ZCLIのセットアップ

インストール

npm install @zendesk/zcli -g

確認

zcli help

Takaaki Kakei

認証

今回はAPIトークンを利用するので、/tokenが必要

zcli login -i

Subdomain: サブドメイン名
Email: メールアドレス/token
Password: APIトークン
Successfully logged in.

Takaaki Kakei

認証関連のコマンド

リスト

zcli profiles:list

認証情報削除

zcli logout

特定サブドメインにおける認証情報削除

zcli profiles:remove {subdomain}

サブドメインのスイッチ

zcli profiles:use {subdomain}

Takaaki Kakei

プロジェクト作成

zcli apps:new

Enter a directory name to save the new app (will create the dir if it does not exist): hello_world_zcli
Enter this app authors name: kakei.takaaki               
Enter this app authors email: kakei.takaaki@example.com
Enter this app authors website (optional): 
Enter a name for this new app: hello_world_zcli

Takaaki Kakei

ローカルサーバーでの起動

zcli apps:server

サーバーを停止するには、Ctrl+C を押す

Takaaki Kakei

ローカルで起動したアプリをZendesk環境にアタッチする方法

ローカルサーバーを起動した状態で以下のURLにブラウザでアクセスする

https://{subdomain}.zendesk.com/agent/tickets/{123}?zcli_apps=true

キャッシュの影響を受けないために、シークレットウィンドウで開くの推奨。

Takaaki Kakei

デプロイ

zcli apps:create

自動でzcli.apps.config.jsonが作成され、app_idも払い出される

Successfully installed app: useful_links with app_id: 1234567

Takaaki Kakei

アプリの更新

zcli apps:update

Takaaki Kakei

manifest.jsonのnameには、-を使わない方が良さそう。アプリインストール時に怒られる模様。

Takaaki Kakei

コマンド補完

Takaaki Kakei

zcli.apps.config.jsonはサブドメインごとに必要そう
ステージごとにフォルダを分けた

% tree                                                                                                                                                                                                                                                                                                             2023/05/08 13:22:11 
.
├── README.md
├── dev
│   ├── LICENSE
│   ├── assets
│   │   ├── iframe.html
│   │   ├── logo-small.png
│   │   ├── logo.png
│   │   ├── logo.svg
│   │   └── screenshots-image.png
│   ├── manifest.json
│   ├── tmp
│   ├── translations
│   │   └── en.json
│   └── zcli.apps.config.json
└── prod
    ├── LICENSE
    ├── assets
    │   ├── iframe.html
    │   ├── logo-small.png
    │   ├── logo.png
    │   ├── logo.svg
    │   └── screenshots-image.png
    ├── manifest.json
    ├── tmp
    ├── translations
    │   └── en.json
    └── zcli.apps.config.json

Takaaki Kakei

ブログ書いた

Takaaki Kakei

ZAFも検証したい

このスクラップは2023/05/08にクローズされました