注文管理向け Veeva CRM API
注文管理 API は、安全な API を使用して、Veeva CRM の注文情報と機能にアクセスを提供します。API は、Veeva CRM プラットフォームにカスタムアプリケーションを構築するために使用され、Veeva CRM へのカスタムサードパーティのインテグレーションをサポートするために使用され、また外部アプリケーションに価格設定ルールロジックとカリキュレーションを表示するために使用されます。API は、Veeva CRM に安全に参照および書込みの方法を提供します。注文管理の価格設定ルールルールロジックすべてをサポートし、さらにカスタム作成された Apex ビジネスロジックと機能します。
Veeva CRM OM API は REST ベースの API で、JSON 形式で使用できます。API の従うべき原則は次の通りです:
- 学習可能である – 直感的で学習しやすい。REST の要素を取り入れて、これらの操作へのアクセスを一貫性がありかつ直感的なものにします。
- セキュアである – API 経由のアクセスは、常に TLS に対して認証され、認証されたユーザのアクセス権限に準拠します
- 効率的である – 効率的にリクエストを処理します。処理には大量のビットが必要で、API は非効率性を最小限に抑えます。
- アライメント – 他の Veeva CRM プラットフォームと同じ基本的なロジックを使用します。API の新しいバージョンが、Veeva CRM の新バージョンに導入された新機能を反映し、ビジネスロジックと一致することを意味します。
OM API 互換性
Veeva CRM は、API の使用時に下位互換性を容易にすることを目指しています。Veeva CRM のリリース全体で、各 API バージョンに対するサポートが維持されています。下位互換性とは、任意の API バージョンで動作するよう作成されたアプリケーションが、将来の Veeva CRM リリースの同じ API バージョンで引き続き動作するということを意味します。ただし、新たに導入される機能は API の旧バージョンでは使用できません。
Veeva CRM は、本番環境のお客様が使用しなくなるまで API の旧バージョンをサポートします。
OM API 制限
- 注文分割ロジックはサポートされていません
- 配送最短時間枠の機能はサポートされていません
OM API 機能
注文操作時に参照エンティティに Salesforce.com 外部 ID を使用する
オブジェクトの「外部 ID」として割り当てられた Salesforce.com のフィールドを使用すれば、アカウントや製品といった注文および注文品目のレコードの関連エンティティを参照することができます。これは、注文の価格設定ルール、作成、変更をする際に行うことができます。この関連オブジェクトの外部 ID を参照する能力は、標準の Salesforce.com API を使用し、外部 ID を使用して挿入/更新を行う能力に似ています。この機能は、注文とその関連注文品目を挿入または更新するのに必要な手順の回数を削減することができます。
注文操作時に RecordTypeId の代わりに RecordType.DeveloperName を使用する
注文および注文品目の作成または変更時に、RecordTypeId の代わりに RecordType.DeveloperName を使用することができます。これにより、クライアントアプリケーションが RecordType のプライマリキーを予め知っておく必要がなくなります。この機能は、注文とその関連注文品目を挿入または更新するのに必要な手順の回数を削減することができます。
API の全コンテンツを表示するには開発者ポータルをご覧ください。
