開発者向け概要 - Shifton Help

デベロッパーページでは、カスタムインテグレーション構築のための Shifton の API ドキュメントと開発者ツールにアクセスできます。

概要

デベロッパーページは、Shifton との技術的なインテグレーションの出発点です。概要（Overview）、Webhooks、アプリケーション（Applications）の3つのタブが含まれています。概要タブには現在および旧バージョンの API ドキュメントへのリンクがあり、カスタムインテグレーションの構築、ワークフローの自動化、または Shifton と社内ツールの接続に使用できます。

前提条件

要件	詳細
ロール	Owner または
知識	API とウェブ開発に関する基本的な理解（または担当開発者へのアクセス）

操作手順

デベロッパーページへのアクセス

左サイドバーの インテグレーション をクリックします。

デベロッパー

ページに移動します。

上部に概要、Webhook、アプリケーション の3つのタブが表示されます。

概要タブの使い方

概要タブには Shifton の API ドキュメントへのリンクが表示されます。

リンク	説明
新しいドキュメント	現在の最新 API ドキュメントへのリンク
旧ドキュメント	古いインテグレーション用のレガシー API ドキュメントへのリンク

新しいドキュメント

をクリックして、現在の API リファレンスを新しいタブで開きます。

古い API で構築された既存のインテグレーションがある場合は、旧ドキュメント をクリックしてレガシーリファレンスにアクセスします。

その他のデベロッパータブへの移動

デベロッパーページからは以下にもアクセスできます。

Webhook

タブ — Shifton からのリアルタイムイベント通知を受け取るウェブフックエンドポイントを設定します。

アプリケーション

タブ — Shifton と統合するカスタムアプリケーションを作成・管理します。

これらの詳細は別の記事で説明しています。

アクセス権限

ロール	デベロッパーページ表示	API ドキュメントへのアクセス	Webhooks/アプリの作成
Owner	はい	はい	はい
	はい	はい	はい
Manager	いいえ	いいえ	いいえ
Employee	いいえ	いいえ	いいえ

よくある質問

Q: デベロッパーページを使用するにはプログラミングスキルが必要ですか？
A: API ドキュメントは開発者向けに設計されています。技術的でない Manager の場合は、開発チームや IT 部門にドキュメントリンクを共有してください。

Q: どちらの API ドキュメントを使用すべきですか — 新しいものか古いものか？
A: すべての新しいインテグレーションには 新しいドキュメント を使用してください。旧ドキュメントは、レガシー API で構築された既存のインテグレーションとの後方互換性のために提供されています。

Q: API にレート制限はありますか？
A: はい、API レート制限が適用される場合があります。リクエスト制限とベストプラクティスの詳細については API ドキュメントを参照してください。

Q: ライブデータに影響を与えずに API 呼び出しをテストできますか？
A: テスト環境またはサンドボックスモードの有無については、API ドキュメントを参照してください。

問題と解決策

問題	考えられる原因	解決策
サイドバーにデベロッパーページが表示されない	Owner またはロールを持っていない	アカウントの Owner に適切なロールの付与を依頼する
ドキュメントリンクがエラーページに繋がる	一時的なサービスの問題	後で再試行するか、Shifton のサポートに連絡する
どちらの API バージョンを使用すべきかわからない	既存のインテグレーションを扱っている	現在のインテグレーションコードの API エンドポイント URL を確認して使用バージョンを特定する
API キーが表示されない	キーを先に生成する必要がある場合	API ドキュメントの指示に従って API キーを生成する