README

AUTENTIQUE Api v2

🚀 使用

这个包使用非常简单，可以为您节省时间。

composer require vinicinbgs/autentique-v2

⚠️ 重要

这个库依赖于 vlucas/phpdotenv 来获取环境变量 (.env)
如果您使用的是像 Laravel 这样的框架，您不需要下载这个库。

为了安全更新，请从主项目分支进行Fork，并使用主库

composer require vlucas/phpdotenv

在文件 .env 中设置

AUTENTIQUE_URL=https://api.autentique.com.br/v2/graphql
AUTENTIQUE_TOKEN="YOUR_TOKEN"
AUTENTIQUE_DEV_MODE="true" || "false"
# if TRUE, document will be created in mode sandbox

摘要

1. 实例
2. 文档
3. 文件夹
4. 贡献 🤠

1. 实例

导入库

use vinicinbgs\Autentique\Documents;

$AUTENTIQUE_TOKEN="xxxxxxxx" (set or will be take in .env)

$documents = new Documents($AUTENTIQUE_TOKEN);

$folders = new Folders($AUTENTIQUE_TOKEN);

为什么文档/文件夹接收令牌？

• 方便管理多个账户中的文档（令牌）

📝 2. 文档

1 - 分页列出所有文档

$documentsPaginated = documents->listAll($page); // if not isset $page is equal 1

2 - 通过ID列出文档

$document = $documents->listById($documentId);

3 - 创建文档

$attributes = [
         'document' => [
             'name' => 'NOME DO DOCUMENTO',
         ],
         'signers' => [
             [
                 'email' => 'email@email.com',
                 'action' => 'SIGN',
                 'positions' => [
                     [
                         'x' => '50', // Posição do Eixo X da ASSINATURA (0 a 100)
                         'y' => '80', // Posição do Eixo Y da ASSINATURA (0 a 100)
                         'z' => '1', // Página da ASSINATURA
                     ],
                     [
                         'x' => '50', // Posição do Eixo X da ASSINATURA (0 a 100)
                         'y' => '50', // Posição do Eixo Y da ASSINATURA (0 a 100)
                         'z' => '2', // Página da ASSINATURA
                     ],
                 ],
             ],
             [
                 'email' => 'email@email.com',
                 'action' => 'SIGN',
                 'positions' => [
                     [
                         'x' => '50', // Posição do Eixo X da ASSINATURA (0 a 100)
                         'y' => '80', // Posição do Eixo Y da ASSINATURA (0 a 100)
                         'z' => '1', // Página da ASSINATURA
                     ],
                     [
                         'x' => '50', // Posição do Eixo X da ASSINATURA (0 a 100)
                         'y' => '50', // Posição do Eixo Y da ASSINATURA (0 a 100)
                         'z' => '2', // Página da ASSINATURA
                     ],
                 ],
             ],
         ],
         'file' => './dummy.pdf',
     ];
 
 $documentCreated = $documents->create($attributes);

4 - 通过ID签署文档

$documentSign = $documents->signById($documentId);

5 - 通过ID删除文档

$documentDeleted = $documents->deleteById($documentId);

6 - 将文档移动到文件夹

$attributes = [
    "folder" => [
                "name" => "folder name",
            ],
];
 
$folder = $folders->create($attributes);
$documentDeleted = $documents->moveToFolder($documentId, $folder["data"]["createFolder"]["id"]);

7 - 将文档从当前文件夹移动到目标文件夹

$documentDeleted = $documents->moveToFolderByFolder($documentId, $targetFolderId, $currentFolderId);

📁 3. 文件夹

1 - 列出所有文件夹

$foldersPaginated = $folders->listAll($page); // if not isset $page is equal 1

2 - 通过ID列出文件夹

$folder = $folders->listById($folderId);

3 - 创建文件夹

$attributes = [
    "folder" => [
                "name" => "folder name",
            ],
];
 
$folder = $folders->create($attributes);

4 - 通过ID列出文件夹内容

$folderContents = $folders->listContentsById($folderId, $page = 1);

5 - 删除文件夹

$folderDeleted = $folders->deleteById($folderId);

🔧 贡献

💻 设置

git clone git@github.com:vinicinbgs/autentique-v2.git
cd autentique-v2
composer install
npm install

⚙️ 配置

创建包含变量的 .env 文件

./contribute.sh

在 vscode 中配置 prettier php

(CTRL + P) > Preferences: Open Setting (JSON)

 "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": "\\.php$",
                "cmd": "npm run prettier -- ${relativeFile} --write",
            },
        ]
    }