fork-lyal/

checkr

checkr.io 的 PHP 客户端,用于后台背景筛查服务

1.9.0 2023-02-27 23:54 UTC

This package is auto-updated.

Last update: 2024-09-29 02:18:45 UTC


README

一个简单的 PHP 包,用于与 www.checkr.com 的 API 进行交互(文档位于 https://docs.checkr.com/),侧重于易用性。

要求

PHP 7.1+

安装

composer require fork-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 或在 PHPUnit 的 XML 文件中设置它。

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