Smartsheet API を使用する革新的な IT チームは、統合が実現して稼働すると、すぐにメリットを実感します。API は、安全なデータ管理、webhook による自動化、会社全体に Smartsheet を拡張する機能の組み合わせを実現させる、開発者向けの強力なツールです。
Smartsheet API を使用して統合を構築したくても、どこから始めれば良いのかわからない場合は、以下に詳しく説明する 5 つのステップに従ってください。
1. 開発者リソースを探す
Smartsheet 開発者ポータルは、すべての開発者リソースの「ホーム ベース」です。そこには、API のドキュメント、Smartsheet SDK に関する情報、ユーザー コミュニティからの API に関する固有の質問に対する回答などがあります。
統合の構築にすぐに着手したいかもしれませんが、事前に時間をかけてこれらのリソースを確認することで、将来的に利益を得ることができます。
API ドキュメントの入手先
動画を見た後、API ドキュメントのページにアクセスしてください。Smartsheet API を直接呼び出す統合を構築する場合でも、Smartsheet SDK を使用する統合を構築する場合でも、API ドキュメントには便利な情報がたくさん含まれています。まずは、以下のセクションをよく理解しましょう。
概要: Smartsheet API を使用するための大まかな背景
はじめに: 統合の土台を築くために必要な情報
トラブルシューティング: 行き詰まったときに問題を処理するための計画を立てる
Smartsheet SDK
Smartsheet ソフトウェア開発キット (SDK) を使用することで、選択したプログラミング言語で Smartsheet API にアクセスできるようになり、すべてのコードを始めから書く必要がなくなります。事前に構築された方法に加えて、各 SDK には再試行ロジック (レート制限エラーの場合) とログ システムも含まれています。
各 SDK (C#、Java、Node、Python、Ruby) にはドキュメントと読み取り/書き込みのサンプルシートがあり、参照可能です。
2. 「開発者登録」を完了する (オプション)
Smartsheet 開発者リソースをしっかり確認したら、統合作成の土台を築く準備が完了します。
開発者アカウントの作成
サードパーティ アプリケーションの構築を計画している場合、または (本番 Smartsheet アカウントのデータに影響を与えることなく) 開発とテスト目的で使用できるサンドボックス Smartsheet アカウントを作成する場合は、開発者登録プロセスを完了する必要があります。
3. API アクセス トークンを生成する
次に、ダイレクト API アクセスで API リクエストを認証するには、アクセスする Smartsheet アカウントが所有する API アクセス トークンが必要になります。アクセス トークンは Smartsheet の UI で生成できます。Smartsheet アカウントにログインして、こちらの指示に従ってトークンを生成します。
OAuth2 フローを実装するサードパーティ アプリケーションを構築して、エンド ユーザーに代わって Smartsheet データにアクセスするために使用できるアクセス トークンを取得する場合は、上記のようにアクセス トークンを手動で生成する必要はありません。サードパーティ アプリ開発に関する情報については、API ドキュメントを確認してください。
ほかのユーザー向けのサードパーティ アプリケーションを構築している場合は、OAuth2 フローを実装してアクセス トークンを取得する必要があります。アクセス トークンを手動ではなく自動生成することで、ユーザーは Smartsheet データにアクセスするための独自のトークンを確実に取得できます。サードパーティ アプリ開発に関する API ドキュメントのセクションを参照することをお勧めします。参考までに、Node.js での Smartsheet OAuth フローの構築についてチュートリアルをご覧ください。
4. 統合の構築を始める
統合の構築プロセスは、SDK を使用するかどうかによって異なります。両方のアプローチを以下で詳しく説明します。
SDK を使用する場合
SDK を統合の基礎として使用するには、それぞれの SDK を提供する手順に従って、選択した SDK をインストールします。次に、コード サンプル用の API ドキュメントを活用して、次の手順に従います。
ページの右側にあるコード サンプル パネルを使用して、関心のある言語のタブを選択します。
それぞれの SDK の注意事項や読み取り/書き込みサンプルを確認します。すべてのリンクは、Smartsheet 開発者ポータルに掲載されています。
任意の API 参照セクションに移動し、SDK を使用して操作を実行する方法を示すコード サンプルを表示します。
SDK を使用しない場合
SDK を使用することでメリットはありますが、必須ではありません。SDK を使用せずにカスタム統合をゼロから構築する場合は、API ドキュメントをプライマリ リソースとして使用します。困ったことがあれば、StackOverflow で smartsheet-api タグを使用して気軽にお問い合わせください。いただいたご質問が、将来誰かの役に立つ可能性があります。
5. Smartsheet にサポートを依頼する
API トラブルシューティングのガイダンスで解決できない API や SDK の問題が発生したり、API ドキュメントによって対処されていない質問が発生したりすることがあるでしょう。StackOverflow に問題または質問を投稿してください。Smartsheet と世界中の何千もの開発者が、サポート体制を整えて待っています。
API に関するフィードバック、または新しい API 機能のご提案は、DevRel@smartsheet.com までご連絡ください。
より多くのリソースを見つける
新しい API を初めて使用する際には学習曲線がありますが、適切なリソースとプロセスがあれば大きな違いをもたらします。
ぜひ、Smartsheet 開発者ポータルのリソースやガイダンスを最大限に活用してください。いずれも Smartsheet API を使いこなすまでにかかる時間を短縮し、自信を持ってソリューションを導入するのに役立つように用意されているものです。
Smartsheet IT ニュースレターを購読して、IT 専門家がビジネスへの影響力を高めるためのヒント、戦略、アイデアを入手してください。
