README

此包使您能够轻松使用 Laravel 框架中的 Serpro Datavalid API。

内容

• 安装

• 用法

安装

您可以通过 composer 安装此包

composer require lucasgiovanny/laravel-serpro-datavalid

用法

1. 将您的凭证添加到 .env 文件中

SERPRO_DATAVALID_CONSUMER_KEY=
SERPRO_DATAVALID_CONSUMER_SECRET=
SERPRO_DATAVALID_SANDBOX=false

1. 要使用此包，您只需要导入 Person Facades。

use  LucasGiovanny\SerproDataValid\Person;

可用方法

• rawValidation：使用任何需要验证的数据进行原始验证，根据 Datavalid API 文档 进行。
• validateName：返回名称是否属于 CPF 以及其确认率。
• validateGender：返回 CPF 是否具有此性别。
• isBrazilian：返回此 CPF 属于的人是否为巴西人。
• validateParentsName：返回父母的姓名是否属于 CPF 以及其确认率。
• isCPFRegular：返回 CPF 是否符合巴西政府规定。
• validatePhoto：返回照片中的人是否为此 CPF 持有人。

rawValidation

示例

use  LucasGiovanny\SerproDataValid\Person;

$data = [
'nome'  =>  "João da Silva",
'sexo' => 'M'
'situacao_cpf'  =>  'regular',
];

$validation = Person::rawValidation("00000000000", $data);

请参阅 Data Valid API 文档 以获取所有可检查属性的列表。

validateName

示例

use  LucasGiovanny\SerproDataValid\Person;

$validation = Person::validateName("00000000000", "João da Silva");
//return true or false;
$validation = Person::validateName("00000000000", "João da Silva", true);
//return an object, like:
	// $validation->nome = true;
	// $validation->nome_similaridade = 0.99

validateGender

示例

use  LucasGiovanny\SerproDataValid\Person;

$validation = Person::validateGender("00000000000", "F"); // gender needs to be "F" or "M"
//return true or false;

isBrazilian

示例

use  LucasGiovanny\SerproDataValid\Person;

$validation = Person::isBrazilian("00000000000");
//return true or false;

validateParentsName

示例

use  LucasGiovanny\SerproDataValid\Person;

$parents = [
	'mother_name' => 'Eurica Magalhães Souza';
	'father_name' => 'Frederico Fagundes Souza';
]; // you can check just one of the names

$validation = Person::validateParentsName("00000000000", $parents);
//return an object with "mother_name" and "father_name" true or false values;

$validation = Person::validateParentsName("00000000000", $parents, true);
//return an object with "mother_name" and "father_name" true or false values, 
//and "mother_name_similarity" and "father_name_similarity" numbers,
//just like in validateName method.

isCPFRegular

示例

use  LucasGiovanny\SerproDataValid\Person;

$validation = Person::isCPFRegular("00000000000");
//return true or false;

validatePhoto

示例

use  LucasGiovanny\SerproDataValid\Person;

$validation = Person::validatePhoto("00000000000", base64_encode($photo));
//return true or false;

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

测试

需要编写测试。欢迎合作。

安全

如果您发现任何安全相关的问题，请通过电子邮件 lucasgiovanny@gmail.com 而不是使用问题跟踪器。

贡献

请参阅 CONTRIBUTING 以获取详细信息。

致谢

• Lucas Giovanny

许可

MIT 许可证 (MIT)。请参阅 许可文件 以获取更多信息。