API連携

2025.05.26

API連携とは、APIを利用して、以下の情報を他システムから登録・更新、あるいは他システムへ情報を送信できる機能です。他システムと当システム両方へ情報を登録していた手間や、CSV出力・入力を繰り返して情報を投入していた手間を省けます。

送受信可能な情報
社員情報、顧客情報（Sales Force Assistantシリーズのみ）、パーソン情報（Sales Force Assistantシリーズのみ）、フリーフォーム（Sales Force Assistantシリーズのみ）、フォームBOX（nyoiboxのみ）、Priv.BOX（nyoiboxのみ）※BOXのアクセス権が設定されている場合は対象外です。
送信のみ可能な情報
案件情報（顧客創造、顧客創造R、顧客深耕R、顧客深耕AO、深耕創造を導入時のみ）
受信のみ可能な情報
案件情報+商談情報（顧客創造、顧客創造R、顧客深耕R、顧客深耕AO、深耕創造を導入時のみ）

補足

API連携の条件について
本機能では、他システムへ情報送信する機能、他システムから送信された情報を受信する機能を提供しています。他システム側に当システムAPIに対応した機能が必要です。また、HTTPまたはHTTPS通信によるPOSTメソッド方式のみの対応となります。送受信される情報やパスワード等の暗号化が必要な場合は、HTTPS通信にてご利用ください。Windows版をIISにてご利用の場合は別途SSL証明書が必要となります。
社員情報及び社員コードについて
同じ社員コードの社員情報が複数ある場合は、情報が特定できないためエラーとなります。
社員コード：他の社員と重複しています。
上記エラーが発生する場合は、使用区分が「使用しない」になっている社員も含めて、社員コードが重複していないかご確認下さい。

注意

設定項目「文字コード」とAPIの利用元が送信する文字列の文字コードが一致していない場合、システムエラーが発生する可能性があります。

受信API

受信APIを設定します。

注意

顧客情報、パーソン情報、案件情報＋商談情報の受信API機能を利用するためには、顧客情報の重複チェック設定が、「顧客コード+除外コード」に設定されている必要があります。設定は、以下の設定画面をご確認ください。
システム設定＞Sales Force Assistant＞顧客情報＞重複チェック

受信APIを設定する

システム設定の「運用管理」より「API連携」の「受信API」を選択します。
⇒「API連携／受信API」画面が表示されます。
受信する情報を選択します。
必要事項を入力し、最後に「保存」ボタンをクリックします。

項目	説明
使用区分	API連携を使用するかしないかを設定します。
入力言語	入力言語を選択します。
文字コード	送信元情報の文字コードを選択します。
送信先URL	自動で表示されます。他システムよりこのURL宛てに情報を送信します。
APIパスワード	受信する際の認証用パスワードを設定します。ここで設定したパスワードを送信元（他システム）から送付し、内容が一致していれば情報を取り込みます。
認証ログイン社員	API受信時の登録・更新処理が可能な社員を選択します。システム管理者権限が付与された社員のみ選択できます。 ※認証ログイン社員に設定した社員は、使用停止または削除を行わないでください。
レイアウト	データ取込時の登録レイアウトを設定します。レイアウトを指定しない場合、新規登録時は基本レイアウトで登録されます。更新時はデータ毎の登録レイアウトを維持します。対象業務は以下の通りです。顧客情報、パーソン情報、案件情報+商談情報(※商談情報のレイアウトを設定します。案件情報のレイアウトは指定できません)、フリーフォーム
連携キー設定	案件情報＋商談情報報の受信API機能の場合のみ、弊社製品の情報を特定する連携キーを、「システムID」「コード」から選択します。
納入機器情報	案件情報＋商談情報報の受信API機能の場合のみ、データ読み込み時に存在しない納入機器情報が入力されていた場合の取込方法を設定します。
面談者	案件情報＋商談情報報の受信API機能の場合のみ、面談者がパーソン情報に存在しない場合の取込方法を「その他の面談者として取り込む」「新規でパーソン情報に登録する」から選択します。
受信API内容	送信元のHTMLコントロール名に合わせて、コントロール名を設定します。送信元に合わせて任意の名前に変更します。

受信に関する注意点

■全般

「APIが使用できません。」のエラーについて
送信元（他システム）から情報を送信後に表示される受信APIコール結果画面において、「APIが使用できません。」と表示される場合、対象の受信APIが「使用しない」に設定されている場合があります。対象APIの設定を確認してください。また、受信パスワードが一致していない可能性もあります。「受信API」の「APIパスワード」と共に、送信側の設定でパスワードを設定しなおしてください。
受信した情報の文字化けについて
送信側から出力されている文字コードと、受信側で設定した文字コードが一致していないことが原因と考えられます。「文字コード」項目をご確認ください。
チェックボックス、ラジオボタン、プルダウンの選択項目について
受信時に選択項目にない値が送信された場合、その情報固有の値となります。値は自動的にマスタ登録されません。その他情報でも必要となる場合は、先にメンテナンスを実施してください。

補足

情報固有の値は以下の特徴があります。

他の情報を表示した際には表示されない。
一度、選択を外して保存すると、再度選択できない。
検索する際に検索条件として利用できない。
顧客ランク、案件分類などの場合、閲覧制限として利用できない。

■社員情報

社員の所属部署、役職情報について
送信元社員情報に所属部署、役職情報が指定されている場合、社員情報と共に取り込みを行います。各情報のコードが指定されている場合はコードで情報を特定し、該当情報が存在すれば更新、存在しなければ新規登録を行います。コード未指定時は名称による特定を行うため、名称変更を行うと情報が特定されず新規で登録されます。名称変更を行う場合は、必ず一意なコードを指定してください。

補足

社員情報を登録時に登録・更新される役職・部署は、社員情報を登録するための最低限の情報のみとなります。名称とコード以外の項目については受信後に必要な項目のメンテナンスを実施してください。
部署情報の表示名についても連携APIでは同期されないため、受信直後は正式名称での表示となります。

所属部署の名称とコードの階層について
社員情報を取り込む際、該当社員の所属部署は必ず、名称とコードの階層を一致させてください。「総務部」に「0001」、「総務部/総務課」に「0002」のコードが設定されている場合、「総務部/総務課」の社員の所属部署コードには「0001/0002」を設定する必要があります。また、複数の部署に所属する場合は、「;」でコードを区切って設定します。例えば「総務部/総務課」と「総務部」に所属する場合は、「0001/0002;0001」を設定します。なお、所属部署を更新時、親部署を変更する更新は行えません。「総務部/総務課（0001/0002）」が存在する状態で、所属部署が「管理部/総務課(0003/0002)」のように設定された社員は登録できません。この場合、事前に所属部署情報を修正する事で取り込み可能となります。
部署コードの混在について
送信元社員情報に部署コードを含めて送信すると、その部署コードで所属部署を特定し取り込みを行ないます。部署コードが設定されていない場合は名称で特定を試みますが、部署コード設定ありの部署と設定なしの部署が混在している場合は取り込めません。たとえば、「総務部」にコードの設定がなく、「総務部/総務課」に「0001」のコードが設定されている場合、「総務部」と「総務部/総務課」に所属している社員を送信しても、取り込めません。
所属部署が指定されなかった場合について
API連携を通して社員情報を登録する場合、所属部署が未指定の場合は「部署未登録」として登録されます。社員登録後に所属部署をメンテナンスしてください。役職についても未指定の場合は役職未選択として登録されます。

補足

社員API連携で所属部署に役職をつける場合は「部署名<役職名>」の形式で入力してください。役職は階層中の部署には設定できません。

メール情報の受信について
メール情報のみ受信登録できない場合、登録元から送られているメールサーバー名が登録されていない、あるいは異なることが考えられます。あらかじめ、基本設定＞メール＞メールサーバーにて同じ名前のメールサーバーを登録する必要があります。
※メールサーバー名は、全角・半角、大文字・小文字も含めて完全一致になります。
印影画像の受信について
API連携でサポートされる情報は文字列のみとなるため、画像データは登録および更新できません。

■顧客情報

顧客コードについて
送信元に一意な顧客コードが付与されていない場合、顧客情報が正しく更新できない場合があります。重複チェック（システム設定＞Sales Force Assistant＞顧客情報＞重複チェック）の設定の「顧客コード未入力は除外コードと見なす」が未チェックの場合、API連携を通して顧客コードが未入力の顧客情報を登録すると、2件目以降は常に上書き更新されます。
※顧客名が全く異なる別顧客であっても、顧客コードが未入力同士で一致したと判断いたします。

送信元に一意な顧客コードが存在しない場合は、除外コードを付与して送信してください。除外コードが付与されている顧客情報は顧客名が一致する場合は更新され、一致しない場合は新規登録されます。送信元で顧客名の変更を行い連携した場合は、顧客名が一致しなくなるため新規登録されます。二重登録となってしまった顧客情報は統合機能を利用して統合してください。
当社担当者とサブ担当者について
顧客情報の当社担当者・サブ担当者には登録済みの社員が設定される必要があります。API連携で顧客情報を受信した場合、社員登録されていない社員が担当者として登録されていると、下記のエラーが発生します。
「[当社担当者]は存在しておりません。」
この場合、担当者として登録している社員情報を受信側にも登録していただく必要があります。

補足

社員の登録は、以下の画面から登録できます。

システム設定＞基本設定＞社員＞社員一覧より社員を新規登録
システム設定＞基本設定＞社員＞社員CSV読み込み
または社員受信APIを利用しての登録も可能となっております。

■パーソン情報

未入力項目の顧客情報からの自動補完について
パーソン情報のTEL・FAX・郵便番号・住所・ビル名等・URL・当社担当者のいずれかが未入力の場合、顧客情報から自動補完されます。顧客情報と同じ内容をパーソン情報へ入力する手間を省けます。以下の注意事項をご確認後、ご活用ください。

入力したTEL・FAXのいずれかが顧客情報と異なる場合、未入力のTEL・FAXは自動補完されません。
入力した郵便番号・住所・ビル名等のいずれかが顧客情報と異なる場合、未入力の郵便番号・住所・ビル名等・TEL・FAXは自動補完されません。
未入力のURL・当社担当者はその他の欄に関わらず自動補完されます。

■案件情報＋商談情報

案件の取り込みについて
同一の連携キー(システムIDまたは、コード)のデータを受信した場合、データは上書きされます。連携キーがシステムIDでかつシステムIDと一致する案件情報IDが登録されていない場合は、エラーとなりますが、それ以外の場合は、データが新規登録されます。
商談情報の取り込みについて
Sales Force Assistantでは、案件の進捗管理を行えます。案件の進捗状況は、商談情報の内容にて更新される仕組みとなっていますので、案件情報＋商談情報の取込においても、商談情報を登録し、案件情報の進捗状況を更新します。
1件の案件情報に関連する商談情報が、1件のみ登録されます。
※システム設定＞Sales Force Assistant＞案件情報＞関連案件入力モードの利用有無に依存しません。
部署、担当者、顧客について
部署、担当者、顧客の取込先は、案件情報、商談情報それぞれに取込元を設定してください。
受信内容について
受信内容項目として上部に案件情報項目、下部に商談情報項目が表示されます。
商談進捗度について
システム設定＞Sales Force Assistant＞案件情報＞受注確度別商談進捗度にて、「受注確度の自動更新設定」が設定されている場合でも、商談進捗度は、取込元の情報が反映されます。
売上見込み項目について
案件情報更新時、売上実績情報に転送されていない明細をすべて削除し、取込元の情報にて、新規登録します。
システム設定＞Sales Force Assistant＞案件情報＞売上情報の自動転送が設定されている場合でも、取り込み時に売上実績情報として自動転送されません。したがいまして、案件情報＋商談情報の取り込みを行う場合は、売上見込を売上実績に登録することをお勧めしません。

■nyoibox（フォームBOX・Priv.BOX）

設定数について
クラウドサービスの場合、設定の上限数は20個です。

送信API

送信APIを設定する

システム設定の「運用管理」より「API連携」の「送信API」を選択します。
⇒「API連携／送信API」画面が表示されます。
「新規登録」ボタンをクリックします。
⇒新規登録画面が表示されます。
必要事項を入力し、最後に「保存」ボタンをクリックします。

項目	説明
使用区分	API連携を使用するかしないかを設定します。
出力言語	出力言語を選択します。使用中言語のみ選択できます。
送信API名	API名を任意に入力します。
送信情報	送信情報をプルダウンより選択します。
送信先URL	他システムの情報受付用URLを設定します。
送信方法	送信方法を選択します。
文字コード	送信先の文字コードを選択します。
使用可能設定	送信APIを利用できる社員を選択します。複数の社員を選択する場合はCtrlキーを押しながらマウスでクリックします。
使用	他システムへ送信する情報をチェックします。
情報名	情報名が表示されます。
コントロール名	送信先のHTMLコントロール名を設定します。送信先に合わせた任意の名前に変更します。
標準コントロール名	デフォルトで設定されたコントロール名が表示されます。
項目追加・除外、追加した項目をすべて除外	※送信情報にnyoiboxを選択している場合、表示されるボタンです。「項目追加・除外」ボタンをクリックして、項目を選択します。BOXにマスター選択を表示している場合、マスター選択先の項目も送信できます。関連情報は5つまで、各情報の項目を10項目まで選択できます。コントロール名は必要に応じて送信先に合わせた任意の名前に変更してください。
追加固定項目	上記情報以外の項目を追加して送信することができます。「行追加」ボタンをクリックして、「情報名」「コントロール名」「送信する値」を入力します。 ※固定項目には、ログイン社員のログイン ID、パスワード、社員コード、サーバー日時を予約語として指定できます。

補足

この設定により、以下の画面から情報送信が可能になります。

社員情報編集画面
顧客情報「顧客検索画面」/「詳細画面」
パーソン情報「パーソン検索画面」/「詳細画面」
案件情報「案件検索画面」/「詳細画面」
フリーフォーム「フリーフォーム検索画面」/「詳細画面」
フォームBOX「一覧画面」/「詳細画面」
Priv.BOX「一覧画面」/「詳細画面」

送信に関する注意点