Partner Connect APIで、Bitrix24を自社サービスに組み込めます

OAuthを一度設定するだけで、あらゆるBitrix24顧客と連携できます。

利用できる機能

OAuthを一度設定すれば、どのBitrix24顧客のアカウントとも連携できます。

顧客ごとの設定は不要

顧客ごとの設定は不要

OAuth連携を一度実装すれば、すべてのBitrix24顧客に対応できます。顧客ごとのウェブフック設定は不要で、アクセス許可も顧客自身がワンクリックで行えます。

使い慣れた標準OAuthで、そのまま連携

使い慣れた標準OAuthで、そのまま連携

GoogleやGitHubと同じ認可コード方式です。既存のOAuthフレームワークに対応し、stateによるCSRF対策、サーバー側でのシークレット管理、キーの取り消しにも対応しています。

必要な権限だけを細かく設定

必要な権限だけを細かく設定

CRMやタスク、電話、ドライブ、AIなど、必要な権限だけを指定できます。管理者はフルアクセスではなく、許可する内容を個別に確認できます。

連携を支えるVibecode API

連携を支えるVibecode API

1つのAPIキーから、1200以上のVibecode APIメソッドを利用できます。60種類以上のエンティティ、CRUD、最大50件のバッチ処理、MongoDB形式のフィルター、自動ページネーションまで利用でき、Bitrix24 RESTを直接操作する必要はありません。

使い方

GoogleやGitHubと同じ、標準OAuthの認可コード方式です。

1

同意画面へ移動

必要なclient_id、redirect_uri、スコープを指定して/v1/connect/authorizeへ移動します。シークレットのないアプリではcode_challengeも指定します。

2

ユーザーが承認

顧客は同意画面でBitrix24アカウントを選択し、要求された権限をまとめて許可します。

3

コードを受け取る

Alaio Vibecodeが、codeとstateパラメータを付けて顧客を指定のredirect_uriへ戻します。

4

コードをAPIキーに交換

POST /v1/connect/tokenにコードを送信すると、永続的なVibecode APIキーが発行されます。シークレットありの場合はclient_secret、なしの場合はワンタイムの文字列ペアを使います。

さまざまなアプリに対応

サーバーサイドサービス、シークレットを持たないモバイルアプリ、ブラウザのないデバイスなど、クライアントの種類に合わせて認証フローを利用できます。

サーバーサイドサービス

一般的なOAuthフローです。シークレットはサーバー側でのみ保持され、ユーザー側に渡ることはありません。

モバイル・デスクトップアプリ

ークレットは使用しません。ログインのたびにPKCE方式でワンタイムの文字列ペアを生成します。リダイレクト先には、任意のポートのlocalhostを利用できます。

ブラウザのないデバイス

短いコードでログインできます。管理画面からアプリの確認を申請し、承認されるとデバイスログインを利用できます。

  • APIキーに有効期限はなく、無効化するまで利用できます。
  • デフォルトでは、1アカウントあたり最大10個のアプリを作成できます。
  • 顧客がいつでもアクセスを管理でき、プロフィールからワンクリックで連携を解除できます。

APIキーで利用できる内容

承認済みのscope内で、Vibecode APIの機能を1つのキーから利用できます。

1200+
Vibecode APIメソッド
60
CRUD対応エンティティ
40+
アクセス権限
50
バッチあたりの呼び出し数

パートナーの活用例

OAuth連携の代表的な3つの活用例をご紹介します。

外部AIアシスタント

顧客のBitrix24データを活用するAIエージェントを、自社サービスのチャットやUIに組み込めます。取引やタスク、連絡先を参照しながら、その場でユーザーをサポートできます。

BIと分析

Bitrix24のデータを直接参照し、売上やコンバージョン、担当者の活動状況などを外部ダッシュボードで可視化できます。手動でデータを書き出す必要はありません。

外部サービスとの連携

外部CRMやERP、メッセージングツール、マーケティングシステム、TelegramボットなどとBitrix24を接続できます。OAuth連携を一度実装するだけで、多数の顧客アカウントに対応できます。

アプリを接続する準備はできましたか?

このページからOAuthクライアントを登録できます。申請や審査は不要で、client_idはすぐに発行されます。redirect_uriを追加し、必要なスコープを選択すれば、そのままユーザーを同意画面へ案内できます。