README

通用API

初始化

认证

为了设置API客户端的认证和初始化，您需要以下信息。

API客户端可以按以下方式初始化。

$userId = 'userId'; // Your user ID
$apiKey = 'apiKey'; // Your API key

$client = new NeutrinoAPILib\NeutrinoAPIClient($userId, $apiKey);

类参考

控制器列表

• 图像处理
• 电话
• 数据工具
• 安全和网络
• 地理位置
• 电子商务
• 网络

图像处理

获取单例实例

可以从API客户端访问Imaging类的单例实例。

$imaging = $client->getImaging();

imageResize

调整图像大小并输出为JPEG或PNG。请参阅：https://www.neutrinoapi.com/api/image-resize/

function imageResize(
        $imageUrl,
        $width,
        $height,
        $format = 'png')

参数

示例用法

$imageUrl = 'image-url';
$width = 19;
$height = 19;
$format = 'png';

$result = $imaging->imageResize($imageUrl, $width, $height, $format);

qRCode

生成一个PNG格式的二维码。查看：https://www.neutrinoapi.com/api/qr-code/

function qRCode(
        $content,
        $width = 256,
        $height = 256,
        $fgColor = '#000000',
        $bgColor = '#ffffff')

参数

示例用法

$content = 'content';
$width = 256;
$height = 256;
$fgColor = '#000000';
$bgColor = '#ffffff';

$result = $imaging->qRCode($content, $width, $height, $fgColor, $bgColor);

imageWatermark

使用另一张图片为图片添加水印。查看：https://www.neutrinoapi.com/api/image-watermark/

function imageWatermark(
        $imageUrl,
        $watermarkUrl,
        $opacity = 50,
        $format = 'png',
        $position = 'center',
        $width = null,
        $height = null)

参数

示例用法

$imageUrl = 'image-url';
$watermarkUrl = 'watermark-url';
$opacity = 50;
$format = 'png';
$position = 'center';
$width = 19;
$height = 19;

$result = $imaging->imageWatermark($imageUrl, $watermarkUrl, $opacity, $format, $position, $width, $height);

hTML5Render

将HTML内容渲染为PDF、JPG或PNG。查看：https://www.neutrinoapi.com/api/html5-render/

function hTML5Render(
        $content,
        $format = 'PDF',
        $pageSize = 'A4',
        $title = null,
        $margin = 0,
        $marginLeft = 0,
        $marginRight = 0,
        $marginTop = 0,
        $marginBottom = 0,
        $landscape = false,
        $zoom = 1,
        $grayscale = false,
        $mediaPrint = false,
        $mediaQueries = false,
        $forms = false,
        $css = null,
        $imageWidth = 1024,
        $imageHeight = null,
        $renderDelay = 0,
        $headerTextLeft = null,
        $headerTextCenter = null,
        $headerTextRight = null,
        $headerSize = 9,
        $headerFont = 'Courier',
        $headerFontSize = 11,
        $headerLine = false,
        $footerTextLeft = null,
        $footerTextCenter = null,
        $footerTextRight = null,
        $footerSize = 9,
        $footerFont = 'Courier',
        $footerFontSize = 11,
        $footerLine = false,
        $pageWidth = null,
        $pageHeight = null)

参数

示例用法

$content = 'content';
$format = 'PDF';
$pageSize = 'A4';
$title = 'title';
$margin = 0;
$marginLeft = 0;
$marginRight = 0;
$marginTop = 0;
$marginBottom = 0;
$landscape = false;
$zoom = 1;
$grayscale = false;
$mediaPrint = false;
$mediaQueries = false;
$forms = false;
$css = 'css';
$imageWidth = 1024;
$imageHeight = 110;
$renderDelay = 0;
$headerTextLeft = 'header-text-left';
$headerTextCenter = 'header-text-center';
$headerTextRight = 'header-text-right';
$headerSize = 9;
$headerFont = 'Courier';
$headerFontSize = 11;
$headerLine = false;
$footerTextLeft = 'footer-text-left';
$footerTextCenter = 'footer-text-center';
$footerTextRight = 'footer-text-right';
$footerSize = 9;
$footerFont = 'Courier';
$footerFontSize = 11;
$footerLine = false;
$pageWidth = 110;
$pageHeight = 110;

$result = $imaging->hTML5Render($content, $format, $pageSize, $title, $margin, $marginLeft, $marginRight, $marginTop, $marginBottom, $landscape, $zoom, $grayscale, $mediaPrint, $mediaQueries, $forms, $css, $imageWidth, $imageHeight, $renderDelay, $headerTextLeft, $headerTextCenter, $headerTextRight, $headerSize, $headerFont, $headerFontSize, $headerLine, $footerTextLeft, $footerTextCenter, $footerTextRight, $footerSize, $footerFont, $footerFontSize, $footerLine, $pageWidth, $pageHeight);

返回控制器列表

Telephony

获取单例实例

可以从 API 客户端访问 Telephony 类的单例实例。

$telephony = $client->getTelephony();

verifySecurityCode

检查来自验证 API 之一的验证码是否有效。见：https://www.neutrinoapi.com/api/verify-security-code/

function verifySecurityCode($securityCode)

参数

示例用法

$securityCode = 'security-code';

$result = $telephony->verifySecurityCode($securityCode);

hLRLookup

连接到全球移动蜂窝网络并检索移动设备的状态。见：https://www.neutrinoapi.com/api/hlr-lookup/

function hLRLookup(
        $number,
        $countryCode = null)

参数

示例用法

$number = 'number';
$countryCode = 'country-code';

$result = $telephony->hLRLookup($number, $countryCode);

phonePlayback

向任何有效的电话号码自动拨打电话并播放音频消息。见：[https://www.neutrinoapi.com/api/phone-playback/](https://www.neutrinoapi.com/api/phone-playback/)

function phonePlayback(
        $number,
        $audioUrl)

参数

示例用法

$number = 'number';
$audioUrl = 'audio-url';

$result = $telephony->phonePlayback($number, $audioUrl);

sMSVerify

通过短信向任何移动设备发送唯一的安全代码。见：[https://www.neutrinoapi.com/api/sms-verify/](https://www.neutrinoapi.com/api/sms-verify/)

function sMSVerify(
        $number,
        $codeLength = 5,
        $securityCode = null,
        $countryCode = null,
        $languageCode = 'en')

参数

示例用法

$number = 'number';
$codeLength = 5;
$securityCode = 110;
$countryCode = 'country-code';
$languageCode = 'en';

$result = $telephony->sMSVerify($number, $codeLength, $securityCode, $countryCode, $languageCode);

sMSMessage

通过短信向任何移动设备发送自由格式消息。见：[https://www.neutrinoapi.com/api/sms-message/](https://www.neutrinoapi.com/api/sms-message/)

function sMSMessage(
        $number,
        $message,
        $countryCode = null)

参数

示例用法

$number = 'number';
$message = 'message';
$countryCode = 'country-code';

$result = $telephony->sMSMessage($number, $message, $countryCode);

phoneVerify

自动拨打任何有效的电话号码并播放唯一的验证码。见：[https://www.neutrinoapi.com/api/phone-verify/](https://www.neutrinoapi.com/api/phone-verify/)

function phoneVerify(
        $number,
        $codeLength = 6,
        $securityCode = null,
        $playbackDelay = 800,
        $countryCode = null,
        $languageCode = 'en')

参数

示例用法

$number = 'number';
$codeLength = 6;
$securityCode = 110;
$playbackDelay = 800;
$countryCode = 'country-code';
$languageCode = 'en';

$result = $telephony->phoneVerify($number, $codeLength, $securityCode, $playbackDelay, $countryCode, $languageCode);

返回控制器列表

DataTools

获取单例实例

可以从API客户端访问DataTools类的单例实例。

$dataTools = $client->getDataTools();

emailValidate

解析、验证并清理电子邮件地址。见：[https://www.neutrinoapi.com/api/email-validate/](https://www.neutrinoapi.com/api/email-validate/)

function emailValidate(
        $email,
        $fixTypos = false)

参数

示例用法

$email = 'email';
$fixTypos = false;

$result = $dataTools->emailValidate($email, $fixTypos);

userAgentInfo

从用户代理字符串中解析、验证并获取详细用户代理信息。查看：https://www.neutrinoapi.com/api/user-agent-info/

function userAgentInfo($userAgent)

参数

示例用法

$userAgent = 'user-agent';

$result = $dataTools->userAgentInfo($userAgent);

badWordFilter

检测给定文本中的不良词汇、脏话和粗俗语言。查看：https://www.neutrinoapi.com/api/bad-word-filter/

function badWordFilter(
        $content,
        $censorCharacter = null)

参数

示例用法

$content = 'content';
$censorCharacter = 'censor-character';

$result = $dataTools->badWordFilter($content, $censorCharacter);

convert

一个强大的单位转换工具。查看：https://www.neutrinoapi.com/api/convert/

function convert(
        $fromValue,
        $fromType,
        $toType)

参数

示例用法

$fromValue = 'from-value';
$fromType = 'from-type';
$toType = 'to-type';

$result = $dataTools->convert($fromValue, $fromType, $toType);

phoneValidate

解析、验证并获取电话号码的位置信息。查看：https://www.neutrinoapi.com/api/phone-validate/

function phoneValidate(
        $number,
        $countryCode = null,
        $ip = null)

参数

示例用法

$number = 'number';
$countryCode = 'country-code';
$ip = 'ip';

$result = $dataTools->phoneValidate($number, $countryCode, $ip);

返回控制器列表

SecurityAndNetworking

获取单例实例

可以通过API客户端访问SecurityAndNetworking类的单例实例。

$securityAndNetworking = $client->getSecurityAndNetworking();

iPProbe

分析并提取IP地址的提供者信息。查看：[https://www.neutrinoapi.com/api/ip-probe/](https://www.neutrinoapi.com/api/ip-probe/)

function iPProbe($ip)

参数

示例用法

$ip = 'ip';

$result = $securityAndNetworking->iPProbe($ip);

emailVerify

基于SMTP的电子邮件地址验证。查看：[https://www.neutrinoapi.com/api/email-verify/](https://www.neutrinoapi.com/api/email-verify/)

function emailVerify(
        $email,
        $fixTypos = false)

参数

示例用法

$email = 'email';
$fixTypos = false;

$result = $securityAndNetworking->emailVerify($email, $fixTypos);

iPBlocklist

IP黑名单API将检测潜在的恶意或危险IP地址。查看：[https://www.neutrinoapi.com/api/ip-blocklist/](https://www.neutrinoapi.com/api/ip-blocklist/)

function iPBlocklist($ip)

参数

示例用法

$ip = 'ip';

$result = $securityAndNetworking->iPBlocklist($ip);

hostReputation

检查IP地址、域名、FQDN或URL的信誉，与黑名单和阻止列表的全面列表进行比对。查看：[NeutrinoAPI 主机信誉 API](https://www.neutrinoapi.com/api/host-reputation/)

function hostReputation(
        $host,
        $listRating = 3)

参数

示例用法

$host = 'host';
$listRating = 3;

$result = $securityAndNetworking->hostReputation($host, $listRating);

返回控制器列表

地理位置信息

获取单例实例

可以通过API客户端访问Geolocation类的单例实例。

$geolocation = $client->getGeolocation();

geocodeReverse

将地理坐标（纬度和经度）转换为实际地址。查看：[NeutrinoAPI 地理编码反向 API](https://www.neutrinoapi.com/api/geocode-reverse/)

function geocodeReverse(
        $latitude,
        $longitude,
        $languageCode = 'en',
        $zoom = 'address')

参数

示例用法

$latitude = 'latitude';
$longitude = 'longitude';
$languageCode = 'en';
$zoom = 'address';

$result = $geolocation->geocodeReverse($latitude, $longitude, $languageCode, $zoom);

iPInfo

获取有关IP地址的位置信息并执行反向DNS（PTR）查找。查看：[NeutrinoAPI IP信息 API](https://www.neutrinoapi.com/api/ip-info/)

function iPInfo(
        $ip,
        $reverseLookup = false)

参数

示例用法

$ip = 'ip';
$reverseLookup = false;

$result = $geolocation->iPInfo($ip, $reverseLookup);

geocodeAddress

将地址、部分地址或地点名称进行地理编码。参见：https://www.neutrinoapi.com/api/geocode-address/

function geocodeAddress(
        $address,
        $countryCode = null,
        $languageCode = 'en',
        $fuzzySearch = false)

参数

示例用法

$address = 'address';
$countryCode = 'country-code';
$languageCode = 'en';
$fuzzySearch = false;

$result = $geolocation->geocodeAddress($address, $countryCode, $languageCode, $fuzzySearch);

返回控制器列表

ECommerce

获取单例实例

可以从API客户端访问ECommerce类的单例实例。

$eCommerce = $client->getECommerce();

bINLookup

执行BIN（银行识别号码）或IIN（发行者识别号码）查找。参见：https://www.neutrinoapi.com/api/bin-lookup/

function bINLookup(
        $binNumber,
        $customerIp = null)

参数

示例用法

$binNumber = 'bin-number';
$customerIp = 'customer-ip';

$result = $eCommerce->bINLookup($binNumber, $customerIp);

返回控制器列表

WWW

获取单例实例

可以从API客户端访问WWW类的单例实例。

$wWW = $client->getWWW();

uRLInfo

从提供的URL解析、分析和检索内容。请参阅：https://www.neutrinoapi.com/api/url-info/

function uRLInfo(
        $url,
        $fetchContent = false,
        $ignoreCertificateErrors = false,
        $timeout = 20)

参数

示例用法

$url = 'url';
$fetchContent = false;
$ignoreCertificateErrors = false;
$timeout = 20;

$result = $wWW->uRLInfo($url, $fetchContent, $ignoreCertificateErrors, $timeout);

hTMLClean

清理和消毒不可信的HTML。请参阅：https://www.neutrinoapi.com/api/html-clean/

function hTMLClean(
        $content,
        $outputType)

参数

示例用法

$content = 'content';
$outputType = 'output-type';

$result = $wWW->hTMLClean($content, $outputType);

browserBot

浏览器机器人可以提取内容，与键盘和鼠标事件交互，并在网站上执行JavaScript。请参阅：https://www.neutrinoapi.com/api/browser-bot/

function browserBot(
        $url,
        $timeout = 30,
        $delay = 3,
        $selector = null,
        $exec = null,
        $userAgent = null,
        $ignoreCertificateErrors = false)

参数

示例用法

$url = 'url';
$timeout = 30;
$delay = 3;
$selector = 'selector';
$exec = array('exec');
$userAgent = 'user-agent';
$ignoreCertificateErrors = false;

$result = $wWW->browserBot($url, $timeout, $delay, $selector, $exec, $userAgent, $ignoreCertificateErrors);

返回控制器列表