ナレッジベース

トピック
API とは?
PipedriveにおけるAPIの動作原理は?

この記事は機械翻訳を使用して作成されました。

APIとは何ですか?

SR
Steven Reinartz, 2024年11月13日
注意: 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 の使用事例

ここでは、Web ページのための API の一般的な利用例をいくつか紹介します。

  • 内部と外部システムの統合
  • 追加機能の追加
  • コストの削減
  • 内部セキュリティの向上
ノート:API の使用事例の詳細については、このWebページをご覧ください。

PipedriveにおけるAPIの動作原理は?

注意: データの安全性を保つためには、他の人とAPIトークンを共有しないようにすることが非常に重要です。誰かがあなたのAPIトークンにアクセスしていると思う場合は、「新しいトークンを生成」をクリックして新しいものを作成してください。その後、新しいトークンで既存のAPI接続を更新する必要があります。

Pipedriveアカウントと他のアプリケーションの間にAPI接続を作成するには、設定 > 個人設定 > API に移動して個人用のAPIキーを見つけてください。

トークンを取得したら、Postman のようなAPIリクエストを容易にするプラットフォームが必要です。

Postmanのセットアップ

注意: PostmanはPipedriveのツールではありませんが、PipedriveアカウントでAPIアクションを実行するために使用することができます。Postmanの詳細ガイドとその動作方法については、Webページをご覧ください。

APIプラットフォームとしてPostmanを使用するには、このリンクを開発者コーナーにフォローし、提供されたリンクを使用してPostmanをダウンロードするか、すでにダウンロード済みの場合は「Postmanで実行」をクリックしてください。

「コレクションのフォーク」を行った後、Pipedriveを通じて利用可能なAPIリクエストを左側で確認できるPostmanワークスペースに移動します。

APIリクエストの作成には通常、いくつかの要素が必要です:

  • あなたのAPIトークン
  • エンドポイント(例:ディール)
  • HTTP動詞(例:GET)
注意: PipedriveはRESTful APIリファレンスを使用しており、エンドポイントとそれらの説明のリストにアクセスできます。開発者ページで確認してください。エンドポイントのリストを確認するには、ページの上部にあるAPIリファレンスの隣にある矢印をクリックしてください。
この記事は役に立ちましたか?

はい

いいえ

関連記事

ご質問がありますか?

お問い合わせ