Remote APIとの統合の概要

目標を設定する

APIを使用して達成したい目標を決定します。参考として、ユースケースや事例をご覧ください。API経由で利用可能なエンドポイントとデータフィールドの一覧については、APIリファレンスドキュメントをご覧ください。

社内リソースを割り当てる

統合を実現するには、Remoteアカウントとコードを書くソフトウェア開発者が必要です。

開発者に管理者権限を付与する

ソフトウェア開発者には、APIトークンを生成できるように、Remoteアカウントの管理者権限が必要です。ソフトウェア開発者にRemoteの管理者権限を付与するには、こちらをクリックしてください。

サンドボックスにアクセスできるようにする

本番用アカウントに変更を加える前に、Remoteのテスト環境にアクセスしてAPIを試行し、結果を検証する必要があります。サンドボックスにアクセスするには、Remoteアカウントにログインし、「Integrations」 > 「Remote API」 > 「Access API」の順に移動します。なお、このページにアクセスするには、Remoteで企業管理者の役割が設定されている必要があります。

テスト用企業を作成する

サンドボックス環境に入ったら、テストに使用できる企業を作成する必要があります。企業を作成するには、「Sign Up」をクリックして登録フローを実行します。この企業で作成したテスト雇用に対して料金は発生しませんので、ご安心ください。

APIアクセストークンを取得する

APIトークンは、ユーザーを認証し、Remote APIにリクエストを行い、自社のデータにアクセスすることを許可するトークンです。テスト環境で「Account Preferences」 > 「API management」の順にアクセスし、こちらの指示に従って、APIトークンを生成できます。なお、このトークンは、サンドボックス環境に対して行われたAPIリクエストに対してのみ機能します。

テストリクエストを実行する

アクセストークンを取得できたら、こちらの例に従い、このトークンを使用してサンドボックス環境へのリクエストを試してみましょう。テスト用企業にログインし、テストリクエストが成功したことを確認します。 

統合を構築し、テストする

API開発者リソースとAPIリファレンスドキュメントを使用して、Remoteとのシームレスな統合を構築し、テストします。構築段階での技術サポートについては、api-support@remote.comまでお問い合わせください。

統合を本番環境に展開する

APIリクエストが期待どおりに動作していることが確認できたら、本番用トークンを生成してリクエストのパスを変更し、本番企業へのリクエスト送信を開始できます。これらの手順の詳細については、こちらをご覧ください。

市場投入までの手順

統合を使用してチームをサポートする

チームからの質問やフィードバックをモニタリングし、ソフトウェア開発者が継続的に反復し、統合を改善できるようにします。