APIとは
メモ：PipedriveでのAPIの使用方法について、詳細が必要な場合は、弊社のCRM APIページをご確認ください。
Pipedriveでは業務をより簡単に、かつ効率的にするための様々な自動化機能やサードパーティの連携機能を提供しています。 しかし、ウェブサイトとPipedriveアカウントとの間でより高度な通信を行いたい場合は、APIが必要となる場合があります。
APIとは
メモ：APIは設定や使用が複雑になる可能性があり、主にソフトウェア開発者によって使用されるツールです。APIに不慣れな場合は、より詳細な情報について弊社の開発者コーナーをご確認いただくことを強くお勧めします。
単純に言えば、API（アプリケーション・プログラミング・インターフェース）とは、2つ以上のアプリケーションが通信する方法です。 外部データベースからデータを取得するようなシンプルな場合もあれば、データを一括で操作する必要があるような複雑な場合もありますが、これを利用することでAPIは企業と従業員の時間を節約する、橋渡しとなるようなものです。
基本的な API 用語
以下は、API に関連する用語と定義の簡単なリストです。
API コール | エンドポイントを設定した後、APIにリクエストを送信すること |
API エンドポイント | APIインタラクションにおける、個々の接点（タッチポイント）の終点 |
API リクエスト | 開発者がURLにエンドポイントを追加し、そのエンドポイントを使用してサーバーやデータベースを呼び出すこと |
APIリクエスト中に使用される一意の識別子。個人またはソフトウェアが主張どおりの相手であることを確認するために使用される | |
API 連携 | APIを使用してデータを交換するための、2つ以上のアプリケーション間の接続 |
JSON（JavaScript Object Notation） | JavaScriptを使用するAPI形式。APIを使用するには、多くの場合、スクリプト言語の少なくとも基本的な理解が必要となる |
メモ: ご自身のアカウントでどのユーザーがAPIにアクセスできるかについての詳細は、こちらの記事をご確認ください。
一般的な API の使用事例
ウェブページにおけるAPIの一般的な用途をいくつか紹介します。
- 内部システムと外部システムの連携
- 追加機能の組み込み
- コストの削減
- 内部セキュリティの向上
ノート：API の使用事例の詳細については、このWebページをご覧ください。
PipedriveにおけるAPIの仕組み
メモ: データを安全に保つため、APIトークンを他者と共有しないことが極めて重要です。 誰かがあなたのAPIトークンにアクセスしていると思われる場合は、新しいトークンを生成 をクリックして新しいものを作成してください。その後、既存のAPI接続をすべて新しいトークンで更新する必要があります。
Pipedriveアカウントと別のアプリケーションとの間にAPI接続を作成するには、設定 > 個人設定 > API に進み、ご自身の個人用のAPIトークン（APIキー）を見つけてください。
トークンを取得したら、Postman のようなAPIリクエストを促進するためのプラットフォームが必要になります。
Postmanの設定
注意： PostmanはPipedriveのツールではありませんが、PipedriveアカウントでAPIアクションを実行するために使用することができます。Postmanの詳細ガイドとその動作方法については、Webページをご覧ください。
PostmanをAPIプラットフォームとして使用するには、こちらのリンクから開発者コーナーに進み、提供されているリンクを使用してPostmanをダウンロードするか、すでにダウンロード済みの場合は Run in Postman（Postmanで実行）をクリックしてください。
コレクションをフォークした後、Postmanのワークスペースに移動します。 ここでは、Pipedriveを通じて利用可能なAPIリクエストを左側で確認できます。
APIリクエストの作成には通常、いくつかの要素が必要です：
- （あなたの）APIトークン
- エンドポイント（例：取引）
- HTTP動詞（例：GET）
メモ: PipedriveはRESTful APIリファレンスを使用しており、エンドポイントのリストとその説明とともに、この開発者ページよりアクセスができます。エンドポイントのリストを表示するには、ページ上部の APIリファレンス の横にある矢印をクリックしてください。