oafasys/salesforce

该包的最新版本(v2.0.1)没有可用的许可证信息。

提供与Salesforce Lightning API交互的服务

v2.0.1 2023-01-20 14:43 UTC

This package is auto-updated.

Last update: 2024-09-20 18:13:26 UTC


README

此包提供了一种直接与Salesforce API接口的简单方法。它包括一些常用函数,以及认证和授权逻辑。

安装

composer require oafasys/salesforce

安装后,发布资源

php artisan vendor:publish

您需要从列表中选择SalesforceServiceProvider。这将创建一个新的配置文件,salesforce.php

配置

您的 .env 应包含

SALESFORCE_ACTIVE=true|false
SALESFORCE_ALERT_ESMS=true|false
SALESFORCE_ENVIRONMENT=prod|staging
SALESFORCE_ID=
SALESFORCE_SECRET=
SALESFORCE_REFRESH=
SALESFORCE_ACCESS=

请注意,无论多少个应用程序使用此包,只有一个应用程序应该将 SALESFORCE_ALERT_ESMS 设置为 true,否则 ESMs 将收到关于错误招聘事件的多个电子邮件。

获取配置值

也许并不令人惊讶,获取访问API所需密钥的过程是复杂的。请检查内部文档来源了解此过程。

用法

扩展Salesforce模型

您可能会发现需要您自己的自定义函数--为此,您可以扩展Salesforce模型并在其中创建自己的方法。如果您发现多个项目需要相同的自定义方法,您可以考虑将它们添加到此包以实现通用访问。

可用方法

getEvents($type, $from = NULL)

`$type` 是 'recruiting' 或 'engagement',$from` 是一个可选的字符串,它将被转换为Carbon对象,用作检索的起点。

此方法返回一个包含所有可用Salesforce数据的完整事件对象的数组。

请注意,此方法只返回 未来的 事件(即,开始日期大于今天的活动)。

`$from` 适用于最后修改日期--自 $from 以来未更新的活动将不会出现在结果中。

getUser($salesforce_id)

此方法返回与 `$salesforce_id` 对应的用户。

getCampaign($salesforce_id)

此方法返回与 `$salesforce_id` 对应的活动。

getObject($object, $field, $value)

此通用方法返回任何具有类型 `$object``$field` 值为 `$value` 的对象。