ナレッジベース

トピック
APIとは何ですか?
PipedriveにおけるAPIの仕組みはどのようなものですか?

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

APIとは何ですか?

SR
Steven Reinartz, 2023年10月20日
注記: 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を使用したAPI形式。APIの使用には少なくとも基本的なスクリプト言語の理解が必要です。
注意:アカウント内でAPIにアクセスできるユーザーの詳細については、この記事を参照してください。

一般的なAPIの使用例

以下は、ウェブページでのAPIの一般的な使用例です。

  • 内部および外部システムの統合
  • 追加の機能の追加
  • コスト削減
  • 内部セキュリティの向上
注意:APIの使用例の詳細については、このWebページを参照してください。

PipedriveにおけるAPIの仕組みはどのようなものですか?

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

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

トークンを取得したら、PostmanなどのAPIリクエストを実行するためのプラットフォームが必要です。

Postmanの設定

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

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

「コレクションをフォーク」した後、左側にはPipedriveを通じた利用可能なAPIリクエストが表示されるPostmanのワークスペースに移動します。

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

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

はい

いいえ

関連記事

ご質問がありますか?

お問い合わせ