lyal/checkr

checkr.io 背景调查服务的 PHP 客户端

0.14 2019-11-13 18:37 UTC

This package is auto-updated.

Last update: 2024-09-19 21:44:33 UTC


README

这是一个简单的 PHP 包,用于与 checkr.com 的 API(文档在 https://docs.checkr.com/)交互,注重易用性。

要求

PHP 7.1+

安装

composer require lyal/checkr

基本用法

<?php
use Lyal\Checkr\Client;

$client = new Client('insert_checkr_api_key_here');

/**
 * Create a new user and send them an invitation
 */

$client->candidate(['email' => 'john.doe@johndoe.com'])->create()->invitation(['package' => 'tasker_pro'])->create();

环境变量

有几个有用的环境变量。为了让 API 测试包工作,您必须使用环境变量 checkr_test_key 设置 checkr_test_key,或者在 PHPUnit 的 XML 文件中设置。

checkr_api_key = 'xxxxxxxxxxx'
checkr_test_key = 'xxxxxxxxxxxx'
use_collections = true