Contents
Pipedrive API連携の基礎と導入目的
Pipedrive APIを活用したシステム連携は、CRMデータのリアルタイム共有や業務自動化に大きく貢献します。特にPipedrive API 連携方法としての技術的選択肢には、REST APIによるカスタム開発とノーコードツールを使う2つのアプローチがあります。それぞれが得意とするシーンがあり、自社のニーズに応じて最適な方法を選ぶことが重要です。たとえば、既存システムとの連携が必要な場合はREST APIが有効ですが、ITリソースが限られている中小企業向けにはノーコードツールがおすすめです。以下のセクションでは具体的な手順や事例を解説します。
Pipedrive APIキーの生成手順（Pipedrive公式ドキュメントに基づいています）
Pipedrive APIを利用するために、まずAPIキーを取得する必要があります。ここではAPIアクセス設定画面での操作から、セキュリティレベル別のキータイプの選択方法までステップバイステップで解説します。
APIアクセス設定画面の確認
- Pipedrive管理画面にログインし、「アカウント」→「APIアクセス」を開きます
- 「新しいAPIキーを生成する」ボタンをクリック
- 生成されたAPIキーはメールにも送信されるため、保存場所をメモしておきましょう
セキュリティレベル別のキータイプ選択
| キータイプ | 使用目的 | 有効期限 | おすすめの用途 |
|---|---|---|---|
| テスト用APIキー | 開発・検証環境 | 1時間 | ローカルでのテストに最適 |
| 本番用APIキー | 生産環境 | 有効期限は明示されていないが、定期的な更新を推奨 | 実際の業務フロー連携に使用 |
注意: APIキーは一回限り生成されるため、失効や変更時はすぐに再発行が必要です。本番環境では定期的なキーマネジメントを実施してください。
OAuth2.0認証フローとトークン管理ベストプラクティス
Pipedrive APIのセキュアなアクセスにはOAuth2.0が標準的に採用されています。アクセストークンの取得フローから、リフレッシュトークンによる永続化戦略までを技術的詳細に解説します。
アクセストークンの取得フロー
-
認証サーバーへリクエスト
POSThttps://api.pipedrive.com/v1/oauth/token -
リクエストボディ:
grant_type=client_credentials,client_id,client_secret -
レスポンスからトークン取得
json
{
"access_token": "AQE43BvX5s...",
"token_type": "Bearer",
"expires_in": 3600
} -
有効期限の管理
expires_inで秒数が取得されるため、アクセス時にトークンの残存時間をチェックし、切替が必要なタイミングを予測します。
リフレッシュトークンによる永続化戦略
- リフレッシュトークンはアクセストークンの再発行に使用されます。
- 通常、リフレッシュトークンの有効期限は30日程度で、APIキーと連動するため定期的に更新が必要です。
- サーバーサイドでは
access_tokenとrefresh_tokenをセキュアに保存し、自動再発行スケジュールを作成することが重要です。
/leadsエンドポイントを用いたリードデータ同期実装例
Pipedriveのリードデータを外部システムと同期するには、/leadsエンドポイントを活用します。POSTやGETメソッドの使い分けや、JSON形式での送信例をPythonとNode.jsで比較しながら解説します。
POSTメソッドによるリード情報送信（Python）
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
import requests url = "https://api.pipedrive.com/v1/leads" headers = { "Authorization": "Bearer YOUR_ACCESS_TOKEN", "Content-Type": "application/json" } data = { "name": "山田太郎", "email": "[メールアドレス削除]", "phone": "090-1234-5678" } response = requests.post(url, headers=headers, json=data) print(response.json()) |
GETメソッドによるリードデータ取得（Node.js）
|
1 2 3 4 5 6 7 8 9 10 |
const axios = require('axios'); axios.get('https://api.pipedrive.com/v1/leads', { headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' } }) .then(response => console.log(response.data)) .catch(error => console.error(error)); |
データ形式とフィールドマッピングのポイント
- 必須項目:
name,email - オプション項目:
phone,company,value（金額） - フィールド名はPipedrive側のカスタムフィールド設定と一致させる必要があります。
エラーハンドリングの例:
python
if response.status == 401:
print("アクセストークンが無効です")
elif response.status == 429:
print("レートリミットに達しています。しばらく待ってください")
Webhookによる自動更新機構構築法
データ変更時にリアルタイムで外部システムへ通知を送るには、PipedriveのWebhook機能を使うと効率的です。イベントタイプの設定やセキュリティ署名検証の技術的ポイントを解説します。
イベントタイプの設定手順
- Pipedrive管理画面から「Webhooks」メニューを開く
- 「新規作成」ボタンで以下を入力:
- イベントタイプ:
lead.create,deal.updateなど - URL: Webhookの受け取り先（例:
https://yourdomain.com/pipedrive-webhook）
セキュリティ署名の検証方法
- Pipedriveから送信されるペイロードにはX-Pipedrive-Signatureというヘッダーが含まれます。
- 受信側では以下の手順で検証します:
- ペイロードと署名を比較（ハッシュ値の計算にSHA256を使用）
- 署名一致の場合は処理を実行、不一致の場合は無視またはエラー処理
例: Pythonでの署名検証コード
python
import hmac
import hashlibdef verify_signature(payload, signature):
computed = hmac.new(
key=b'YOUR_SECRET_KEY',
msg=payload.encode('utf-8'),
digestmod=hashlib.sha256
).hexdigest()
return computed == signature
Yoomプラットフォームによるノーコード連携設定
ITリソースが限られている中小企業でも、Yoomプラットフォームを使えばPipedriveとのノーコード連携が可能です。アカウント連携手順や自動ルール作成テンプレートを具体的に解説します。
アカウント連携手順
- Yoomの公式サイトから「Pipedrive」というアプリを探してインストール
- PipedriveアカウントとYoomアカウントを連携（OAuth認証）
- 連携先にしたいツール（例: Slack, Google Sheets）も選択
自動ルール作成テンプレート
- トリガー: 「Pipedriveで新しい取引が作成されたら」
- アクション: 「関連するリードをGoogle Sheetsに自動作成」
- Yoomでは以下のフィールドマッピングが可能です:
lead.name→名前（A列）deal.value→金額（B列）
事例: Yoom公式記事によると、リードの自動追加処理を設定した企業では作業時間を38%削減できています。
まとめ
本記事ではPipedrive API連携方法について、技術的詳細とノーコードオプションの両面から解説しました。以下が要点です:
- APIキー生成: テスト環境用と本番環境用を分けることでセキュリティ強化
- OAuth2.0認証: アクセストークンとリフレッシュトークンの管理は自動化必須
- /leadsエンドポイント: POST/GETメソッドによるリード同期の実装例をPython・Node.jsで提供
- Webhook: リアルタイム通知を構築するイベント設定と署名検証の技術的ポイント
- Yoomノーコード連携: ITリソースが限られている企業向けに、UI操作でのフィールドマッピングテンプレートを紹介
自社の業務フローとIT環境に応じて、REST APIやYoomなど最適な方法を選択してください。