記事

Smartsheet API を使い始めるための 5 つのステップ

byTaylor Krusen

Smartsheet API を使用している革新的な IT チームは、統合を開始してすぐにその効果を実感しています。 API は開発者にとって強力なツールであり、安全なデータ管理、Web フックによる自動化、および会社全体に Smartsheet を拡張する機能の組み合わせの実現をサポートします。

Smartsheet API を使用して統合を構築したいけれども、どこから始めればいいのかわからない場合、 以下に示す 5 つのステップに従ってください。

1. 開発者リソースを確認する

Smartsheet 開発者ポータルは、すべての開発者リソースの「本拠地」です。 ここには、API ドキュメント、Smartsheet SDK に関する情報、ユーザー コミュニティからの API に関する質問への回答などが掲載されています。

統合の構築にすぐに取り掛かりたいと思うかもしれませんが、前もってこれらのリソースを検討する時間を設けることで、将来的には利益を得ることができます。

API ドキュメントの掲載場所

動画をご覧になった後は、API ドキュメントのページをご覧ください。 Smartsheet API を直接呼び出す統合を構築する場合でも、Smartsheet SDK を使用する統合を構築する場合でも、API ドキュメントには多くの有用な情報が含まれています。 まずは、以下のセクションをよく理解することから始めましょう。

Smartsheet SDKs

Smartsheet ソフトウェア開発キット (SDK) は、すべてのコードをゼロから記述することなく、選択したプログラミング言語を使用して Smartsheet API にアクセスする手段を提供します。 各 SDK には、あらかじめ用意された手法に加えて、再試行ロジック (レート制限エラー用) やロギングシステムも搭載されています。

それぞれの SDK (C#Java节点PythonRuby) には、参照用のドキュメントとサンプルの読み取り/書き込みシートが用意されています。

2. 「開発者登録」を完了する (オプション)

Smartsheet の開発者リソースをご覧になったら、統合を作成するための基礎を築く準備が整いました。

開発者アカウントを作成する

サードパーティ アプリケーションの構築を予定している場合や、開発やテスト目的で使用できる (本番用の Smartsheet アカウントのデータに影響を与えない)サンドボックスの Smartsheet アカウントを作成したい場合は、開発者登録プロセスを完了する必要があります。

3. アクセス トークンを生成する

Smartsheet へのアクセスを許可するための画面キャプチャ

次に、ダイレクト API アクセスを介して API リクエストを認証するには、アクセスしたい Smartsheet アカウントが所有する API アクセストークンが必要です。 アクセス トークンは Smartsheet の UI で生成できます。 Smartsheet のアカウントにログインし、こちらの指示に従ってトークンを生成してください。

OAuth2 フローを実装してアクセス トークンを取得し、エンド ユーザーに代わって Smartsheet データにアクセスできるようにするサードパーティ アプリケーションを構築する場合は、上記のようにアクセス トークンを手動で生成する必要はありません。 サードパーティのアプリ開発に関する情報は、API ドキュメントを参照してください。

他のユーザーを対象としたサードパーティのアプリケーションを構築する場合、アクセストークンを取得するための OAuth2 フローを実装する必要があります。 アクセス トークンを手動ではなく自動的に生成することで、Smartsheet データにアクセスするためにユーザーがそれぞれのトークンを確実に所有できるようになります。 サードパーティ アプリの開発については、API ドキュメントのセクションを参照することをお勧めします。 ご参考までに、节点.js で Smartsheet OAuth フローを構築するチュートリアルをご紹介します。

4. 統合の構築を開始する

統合を構築するプロセスは、SDK を使用するかどうかによって異なります。 両方のアプローチについて、以下に詳しく説明します。

SDK を使用する

統合の基盤として SDK を使用するには、それぞれのSDKに提供されている手順に従って、選択した SDK をインストールします。 次に、コード サンプルの API ドキュメントを活用して、次の手順に従います。

  1. ページの右側にあるコード サンプル パネルを使用して、関心のある言語のタブを選択します。

  2. それぞれの SDK の readme と読み取り/書き込みサンプルを確認してください。 すべてのリンクは、Smartsheet 開発者ポータルで入手できます。

  3. API リファレンスセクションに移動して、SDK を使用して操作を実行する方法を示すコード サンプルを確認してください。

SDK を使用しない

SDK を使用することでメリットを得ることができますが、必須ではありません。 カスタム統合をゼロから構築するために SDK の使用をやめる場合は、API ドキュメントを主なリソースとして活用してください。 行き詰まった場合は、smartsheet-api タグを使用して StackOverflowで遠慮なく質問してください。 あなたの質問が将来誰かの役に立つかもしれません。

5. Smartsheet にサポートを依頼する

API トラブルシューティングガイダンスを使用しても解決できない API または SDK の問題が発生したり、API ドキュメントに記載されていない質問がある場合があります。 問題や質問をStackOverflowに投稿してください。StackOverflow では、世界中の何千人もの開発者が待機しています。

API に関するフィードバックがある場合、API の新機能を提案したい場合は、 DevRel@smartsheet.com までご連絡ください。

その他のリソースを見る

新しい API を初めて使用する際には習得が大変ですが、適切なリソースとプロセスがあれば大きな違いが生まれます。

Smartsheet API の使用に慣れるまでの時間を短縮し、自信を持ってソリューションを展開できるようにするためのリソースやガイダンスが掲載されているSmartsheet 開発者ポータルを最大限にご活用ください。

Smartsheet IT ニュースレターを購読すると、IT 担当者がビジネスへの影響力を高めるために役立つヒントや戦略、アイデアを得ることができます。