README

官方 Docparser API PHP 客户端

docparser-php 为 Docparser API 提供了方便的 PHP 绑定。

文档

有关 Docparser API 的通用描述，请参阅我们的开发者文档此处。我们的开发者文档列出了所有可用的 API 方法及其参数和预期响应。

安装

此库需要 php 5.5 或更高版本。

使用 Composer:

composer require docparser/docparser-php

或在 composer.json

{
    "require": {
        "docparser/docparser-php": "1.*"
    }
}

配置

使用您的 Docparser API 令牌创建 Docparser PHP 客户端

require('./vendor/autoload.php');

use Docparser\Docparser;
$docparser = new Docparser("APITOKEN");

测试您的身份验证

您可以通过调用我们的 ping() 方法来测试您的 API 密钥。该方法返回一个布尔值，表示是否可以建立到我们 API 的连接以及 API 密钥是否有效。

echo $docparser->ping();

使用

文档解析器

列出所有文档解析器

返回您账户中创建的文档解析器的列表。

$docparser->getParsers();

文档

Docparser PHP SDK 提供了三种不同的方法来导入您的文档。

所有导入方法都允许您传递一个与您的文档相关的 $remoteId。远程 ID 可以是任意字符串，最大长度为 255 个字符。提交的值将在处理过程中保持不变，并在您通过我们的 API 或通过 Webhooks 获取解析数据后可用。

从本地文件系统上传文档

从您的本地文件系统中读取文件并将其上传到您的文档解析器。

$docparser->uploadDocumentByPath($parserId, $filePath, $remoteId = null);

通过提供文件内容上传文档

此方法根据原始文件内容或文件指针在您的文档解析器中创建一个新的文档。此外，还可以提供文件名。

$docparser->uploadDocumentByContents($parserId, $file, $remoteId = null, $filename = null);

从 URL 获取文档

从公开的 HTTP(S) URL 导入文档。

$docparser->fetchDocumentFromURL($parserId, $url, $remoteId = null);

解析数据

Docparser API 允许您检索提取的文档数据。您可以选择列出多个文档的数据或获取特定文档的数据。

用于检索解析数据的两种方法都允许您指定“格式”参数 - 这允许您在平面结构和嵌套数组结构之间进行选择。对于大多数实现，将其保留为“对象”即可。

请注意：轮询 API 以获取新结果不是获取数据的首选方式。与轮询我们的 API 以获取解析数据相比，使用 Webhooks 是更好的方式。通过使用 Webhooks，解析数据将在解析后立即推送到您的 API。

获取一个文档的数据

通过提供 $parserId 和 $documentId 来获取特定文档的解析数据。$documentId 是通过 API 导入文档时返回的 Docparser 文档 ID。

$docparser->getResultsByDocument($parserId, $documentId, $format = 'object');

获取多个文档的数据

获取特定文档解析器解析的多个文档的结果。此函数允许您对结果进行精细筛选和排序。请参阅我们的文档了解可用参数列表。

$docparser->getResultsByParser($parserId, $options = []);

贡献

欢迎在 GitHub 上提交错误报告和拉取请求。

请按照 PSR-2 规范进行您的贡献，并注意任何更改或新需要的 phpDoc 注释。

许可证

该库在 MIT 许可证的条款下作为开源软件提供。

MIT 许可证 (MIT)

在此特此授予任何获得此软件及其相关文档文件（“软件”）副本的任何人，在软件上无限制地处理软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许向提供软件的人员授权这样做，前提是遵守以下条件

变更日志

2017年11月10日初版

docparser / docparser-php

维护者

详情