Zoho CRM APIのバージョン1.0は、2018年12月31日に提供を終了しました。機能が向上した新しいAPI バージョン2.0をお試しください。

APIバージョン1.0の変更点 - GDPRコンプライアンス

GDPRとは？
APIの新機能
項目API
追加API
更新API
取得API
データ検索API
エラーメッセージ

GDPRとは？

GDPRは、既存のデータ保護指令または指令95/46/ECに代わる包括的な一連の規制であり、EU全体で施行されます。世界中の個人データ送信がますます複雑になっているため、それらのデータの処理方法を直接管理し、データのプライバシーを保護することで、EUの居住者に権限を与えることを目的としています。

注：

ここに記載されている内容は、法的助言として見なされるべきものではありません。GDPRが組織に与える影響と、GDPRに準拠するために必要な行動については、貴社の法務担当にお問い合わせください。

APIの新機能

フィールド

データ処理の根拠の詳細

「データ処理の根拠の詳細」という名前の新しい項目に、特定のデータのデータ処理の法的根拠が表示されます。この項目の値は、顧客のデータの処理方法に基づいて決定できます。

現在、この項目は、［見込み客］、［連絡先］、［仕入先］、［カスタム］タブでのみサポートされています。

項目の値は次のとおりです。

適用なし、正当な利益、契約、法的義務、重大な利益、公共の利益、同意の保留、同意の待機、同意の取得、同意の無回答、処理の停止、同意の拒否、削除。

注：

同意の保留 - 同意リンクまたはフォームはまだ顧客に送信されていません。
同意の待機 - 同意リンクまたはフォームがカスタマーに送信され、返信を待っています。
同意の取得 - 同意リンクまたはフォームが送信され、顧客が「アクセス権」を付与しました（承認されました）。
同意の拒否 - 同意フォームが送信され、顧客が「処理の停止」と回答しました。

属性

プライベート

「private」という名前の同意タグの属性がAPIに追加され、項目が保護項目としてマークされます。このキーのデータ型は真偽値型、つまり、true/falseです。

プライベートタイプ

「private_type」という名前の同意タグの属性が追加されます。このキーの値は、「High」、「Low」、「null」のいずれかです。「High」と「Low」の値は、CRM UIの場合と同様に「Sensitive」と「Normal」の値に対応しています。

処理の停止

特定のデータの処理の停止のキーが「true」の場合、そのデータは表示専用になります。このキーの値は、真偽値データ型、すなわち、trueまたはfalseです。

例：

このキーが重要になる場合：

同意フォームが、リクエストを一時的に停止するようにリクエストを行った顧客に送信され、その後、処理の停止のリクエストが送信されます。
データ管理者、つまり、組織の管理者（CEO）は、同意段階が「保留中」または「待機中」のときは、いつでもプライバシー設定の処理の停止が有効になるように組織を設定できます。

項目API

新しいプライバシーポリシーの実装に基づいて、項目APIに加えられた変更は次のとおりです。

属性「private」は、項目が保護されている（プライベート）かどうかを示します。このキーのデータ型は真偽値型、つまり、true/falseです。
属性「private_type」は、データの機密性のレベルを示します。たとえば、データの機密性が高に設定されている場合は、private_type="High"です。

注：

非プライベート項目の場合、つまり、「private=false」の場合は、private_type="null"。
プライベート項目は、条件を使用して検索することはできません。

URL : {module}/getFields, {module}/getAllFields

レスポンス例

追加API

「同意」という名前の新しいタグには、顧客が承諾した同意書の詳細が含まれます。別の意味では、リクエスト内でこのタグを使用して、特定のデータに同意の詳細を追加できます。

新しいプライバシーポリシーの実装に基づいて、追加APIに加えられた変更は次のとおりです。

入力データには、CONSENTIDを指定できません（既存の同意を関連付けることはできません）
同意（<consent></consent>）にはメールを指定できません
挿入APIは、処理の停止のメールIDにエラーをスローしません。代わりに、処理を停止するメールIDを使用してデータが作成され、処理の停止に移動してください。
無効なメールがデータ（<row></row>）に入力されている場合は、検証されます。

注：

上記の使用例は、次の場合にのみ適用されます。

組織のコンプライアンス設定機能が有効になっている（Zohoが実行）。
GDPRコンプライアンスが、ユーザーに対して有効になっている（ユーザーが指定）。
アクセスされるタブは、データプライバシータブの1つである必要があります（［タブのデータプライバシーの管理］オプションを介してユーザーが選択できます）。

入力例

<Leads>
  <row no="1">
    <FL val="Last Name">Patricia</FL>
    <FL val="Email">p.boyle@zylker.com</FL>
    <FL val="Data Processing Basis Details">
      <consent>
        <FL val="Contact through Email">true</FL>
        <FL val="Contact Through Phone">false</FL>
        <FL val="Contact Through Survey">false</FL>
        <FL val="Contact Through Social Handles">false</FL>
        <FL val="Consent Through">Email</FL>
        <FL val="Consent Date">2018-04-27</FL>
        <FL val="Allow Other Service">true</FL>
        <FL val="Consent Remarks">Consent approved by customer</FL>
        <FL val="Data Processing Basis">Obtained</FL>
      </consent>
    </FL>
  </row>
</Leads>

更新API

新しいプライバシーポリシーの実装に基づいて、更新APIに加えられた変更は次のとおりです。

入力データには、CONSENTIDを指定できません（既存の同意を関連付けることはできません）
同意（<consent></consent>）にはメールを指定できません
無効なメールがデータ（<row></row>）に入力されている場合は、検証されます。

注：

上記の使用例は、次の場合にのみ適用されます。

組織のコンプライアンス設定機能が有効になっている（Zohoが実行）。
GDPRコンプライアンスが、ユーザーに対して有効になっている（ユーザーが指定）。
アクセスされるタブは、データプライバシータブの1つである必要があります（［タブのデータプライバシーの管理］オプションを介してユーザーが選択できます）。

入力例

取得API

新しいプライバシーポリシーの実装に基づいて、取得API（getRecords/getRecordById/getRelatedRecords/searchRecords/searchRecordsByPDC/getSearchRecords）に加えられた変更は次のとおりです。

include_pi_fields=trueが指定されている場合、タブのプライベート項目はデータ取得APIで提供されます。
$stop_processingキーは、すべての取得APIレスポンスで提供されます。

注：

上記の使用例は、次の場合にのみ適用されます。

組織のコンプライアンス設定機能が有効になっている（Zohoが実行）。
GDPRコンプライアンスが、ユーザーに対して有効になっている（ユーザーが指定）。
アクセス対象のタブは、データプライバシータブに該当する必要があります（［タブのデータプライバシーの管理］オプションを介してユーザーが選択できます）。

レスポンス例

<response uri="/crm/private/xml/Leads/getRecords">
    <pi_fields>
        <FL id="111111000000000863" label="Company" private="true" private_type="High" export="false"></FL>
        <FL id="111111000000000873" label="Email" private="true" private_type="Low" export="false"></FL>
        <FL id="111111000000000875" label="Phone" private="true" private_type="High" export="false"></FL>
        <FL id="111111000000000877" label="Fax" private="true" private_type="High" export="false"></FL>
    </pi_fields>
    <result>
        <Leads>
              <row no="1">
                <FL val="LEADID">111111000000056343</FL>
                <FL val="$stop_processing">false</FL>
                <FL val="SMOWNERID">111111000000031431</FL>
...
              </row>
        </Leads>
    </result>
</response>

データ処理の根拠の詳細でのレスポンス：

レスポンス例

<FL val="Data Processing Basis Details">
    <consent>
        <FL val="CONSENTID">111111000000032361</FL>
        <FL val="Contact through Email">true</FL>
        <FL val="Contact Through Phone">false</FL>
        <FL val="Contact Through Survey">false</FL>
        <FL val="Contact Through Social Handles">false</FL>
        <FL val="Email">null</FL>
        <FL val="SMCREATORID">111111000000031431</FL>
        <FL val="Created By">Boyle GDPR</FL>
        <FL val="MODIFIEDBY">111111000000031431</FL>
        <FL val="Modified By">Boyle GDPR</FL>
        <FL val="SMOWNERID">111111000000031431</FL>
        <FL val="Consent Owner">Boyle GDPR</FL>
        <FL val="Created Time">2018-04-26 20:33:34</FL>
        <FL val="Modified Time">2018-04-26 20:33:34</FL>
        <FL val="Consent Through">Email</FL>
        <FL val="Consent Date">2018-04-27</FL>
        <FL val="Consent Ends On">null</FL>
        <FL val="Allow Other Service">false</FL>
        <FL val="Consent Remarks">Consent accepted by the customer.</FL>
        <FL val="Data Processing Basis">Obtained</FL>
        <FL val="Mail Sent Time">null</FL>
        <FL val="Consent Lawful Details">null</FL>
        <FL val="Consent Other Details">null</FL>
    </consent>
</FL>

データ検索API

プライベートとしてマークされた項目は、検索条件、searchCondition、 searchColumn、customview条件を使用して取得できません。プライベート項目を検索すると、次のレスポンスが表示されます。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/crm/private/xml/Leads/searchRecords">
    <error>
        <code>4899</code>
        <message>API call cannot be completed as private field given in criteria/searchCondition/searchColumn/customview</message>
    </error>
</response>

エラーメッセージ

次のエラーメッセージは、データのinsert API、update API、upsert API、convertLead API、sendMail APIに対してスローされます。

レスポンス例

<response uri="/crm/private/xml/Leads/convertLead">
    <error>
        <code>4202</code>
        <message>API call cannot be completed as the record is in stop processing</message>
    </error>
</response>

注：

ブロック済み - ブロック済みステータスはデータに追加し、「メール」項目を識別項目として作成することで、特定のデータをブロックまたはロックするために使用できます。つまり、特定のメールのデータがブロックされている場合、同じメールのデータを追加または更新することはできません。