README

eRecht24 Rechtstexte-SDK 允许您的服务/服务器与 eRecht24 Rechtstexte-API 交互。此包由 eRecht24.de 正式支持。我们建议使用此包以使用 eRecht24 Rechtstexte-API 服务。

要求

PHP 7.1 或更高版本

安装

使用 composer 添加包

composer require erecht24/rechtstexte-sdk:"<2.0"

快速入门

创建您的 API 密钥

API 密钥可以使用 eRecht24 项目经理生成。有一个用于开发和测试的密钥。请随意使用它

e81cbf18a5239377aa4972773d34cc2b81ebc672879581bce29a0a4c414bf117

获取您的开发者密钥（或插件密钥）

请注意，所有联系 eRecht24 Rechtstexte-API 的插件都必须发送经过验证的开发者密钥。开发者密钥（或插件密钥）是 eRecht24 向每位开发者发放的唯一密钥，用于识别与 eRecht24 Rechtstexte-API 通信的不同插件。在您签署了 API 的条款和条件后，将发放密钥。请联系我们： api@e-recht24.de

法律文本模型

三种不同法律文本类型的基础模型。

您可以使用包装类导入法律文本类型

switch ($type) {
    case Helper::PUSH_TYPE_IMPRINT:
    case Helper::PUSH_TYPE_PRIVACY_POLICY:
    case Helper::PUSH_TYPE_PRIVACY_POLICY_SOCIAL_MEDIA:
        $legalTextHandler = new LegalTextHandler('YOUR_API_KEY', $type, 'YOUR-PLUGIN-KEY');
        /* @var LegalText $legalText */
        $legalTextDoc = $legalTextHandler->importDocument();
        $legalText = $legalTextDoc->getHtmlDE();
{ ... }

获取文档对象后，您可以读取 html 文本

if ($imprint = $apiHandler->getImprint()) {
    $html = $imprint->getHtmlDE();
}

或使用动态语言支持

if ($imprint = $apiHandler->getImprint()) {
    $html = $imprint->getHtml('en');
}

客户端模型

已注册的客户端可以接收推送通知。

// new client data
$newClient = (new Client())
    ->setPushMethod('POST')
    ->setPushUri('https://test.de/push')
    ->setCms('WP')
    ->setCmsVersion('8.0')
    ->setPluginName('erecht24/rechtstexte-wp')
    ->setAuthorMail('test@test.de');

每个项目最多支持 3 个客户端。

用法 :: 代码示例

此简单示例在您的项目中注册了一个新的客户端（API 密钥）并获取了实际印文本的 html 版本。

// require composer autoloader, update/extend to your needs
// require_once '<path_to_project_root>/vendor/autoload.php';

use eRecht24\RechtstexteSDK\ApiHandler;
use eRecht24\RechtstexteSDK\Model\Client;
use eRecht24\RechtstexteSDK\Exceptions\Exception;

// initialize api handler
$apiHandler = new ApiHandler('YOUR-API-KEY', 'YOUR-PLUGIN-KEY');

// the new client data
$newClient = (new Client())
    ->setPushMethod('POST')
    ->setPushUri('https://test.de/push')
    ->setCms('WP')
    ->setCmsVersion('8.0')
    ->setPluginName('erecht24/rechtstexte-wp')
    ->setAuthorMail('test@test.de');

try {
    // create the new client
    $client = $apiHandler->createClient($newClient);

    if (!$apiHandler->isLastResponseSuccess()) {
        // do stuff in case of an error
    }

    if ($imprint = $apiHandler->getImprint()) {
        // example: get DE imprint
        $html = $imprint->getHtmlDE();
    }

} catch (Exception $e) {
    // as you need, log or rethrow here
}

// now go on with whatever service you want to execute

有关其他服务操作的完整文档，请参阅 API 处理程序。

许可

请查看我们的使用条款。

服务

eRecht24 Rechtstexte-API 文档可以在这里找到。

erecht24 / rechtstexte-sdk

维护者

详细信息