Skip to content

Commit

Permalink
Alteração da variável sandbox que espera uma string
Browse files Browse the repository at this point in the history
  • Loading branch information
@mayder
mayder committed Aug 17, 2022
1 parent 4abca63 commit 5fbbaf4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 195 deletions.
195 changes: 1 addition & 194 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,194 +1 @@
#### AUTENTIQUE Api v2

[![Latest Stable Version](https://img.shields.io/packagist/v/mayder/autentique-v2)](https://packagist.org/packages/mayder/autentique-v2)
[![Total Downloads](https://poser.pugx.org/mayder/autentique-v2/downloads)](https://packagist.org/packages/mayder/autentique-v2)
[![Build Status](https://travis-ci.org/mayder/autentique-v2.svg?branch=master)](https://travis-ci.org/mayder/autentique-v2)
[![codecov](https://codecov.io/gh/mayder/autentique-v2/branch/master/graph/badge.svg)](https://codecov.io/gh/mayder/autentique-v2)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mayder/autentique-v2/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mayder/autentique-v2/?branch=master)
[![Code Intelligence Status](https://scrutinizer-ci.com/g/mayder/autentique-v2/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
[![License](https://poser.pugx.org/mayder/autentique-v2/license)](https://packagist.org/packages/mayder/autentique-v2)

# 🚀 Usage

## This package is so simple to use that it will save your time.

```bash
composer require mayder/autentique-v2
```

## ⚠️ IMPORTANT

This library depends on **vlucas/phpdotenv** to get environments variables **(.env)** <br>
If you use a framework like **Laravel**, you don't need to download this library.

```bash
composer require vlucas/phpdotenv
```

**Set in file .env**

```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
```

# Instance
**Import library**

```php
use mayder\Autentique\Documents;

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

$documents = new Documents($AUTENTIQUE_TOKEN);

$folders = new Folders($AUTENTIQUE_TOKEN);
```

Why documents/folders receive token?
- Easily to manage Documents in multiples accounts (token)

# 📝 Documents
### 1 - List all documents with pagination

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

### 2 - List the document by id

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

### 3 - Create a document

```php
$attributes = [
'document' => [
'name' => 'NOME DO DOCUMENTO',
],
'signers' => [
[
'email' => '[email protected]',
'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 protected]',
'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 - Sign the document by id

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

### 5 - Delete the document by id

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


# 📁 Folders
### 1 - List all folders

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

### 2 - List the folder by id

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

### 3 - Create a folder

```php
$attributes = [
"folder" => [
"name" => "folder name",
],
];

$folder = $folders->create($attributes);
```

### 4 - List the folder contents by id

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

### 5 - Delete a folder

```php
$folderDeleted = $folders->deleteById($folderId);
```
# 🔧 Contributing

### 💻 Setup

```sh
git clone [email protected]:mayder/autentique-v2.git
cd autentique-v2
composer install
npm install
```

### ⚙️ Configure

#### Create .env with variables

```sh
./contribute.sh
```

#### Configure prettier php in vscode

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

```json
"emeraldwalk.runonsave": {
"commands": [
{
"match": "\\.php$",
"cmd": "npm run prettier -- ${relativeFile} --write",
},
]
}
```
#### AUTENTIQUE Api v2
2 changes: 1 addition & 1 deletion src/BaseResource.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class BaseResource
public function __construct(string $autentiqueURL = "", bool $autentiqueDevMode = false)
{
$this->api = new Api($autentiqueURL);
$this->sandbox = $autentiqueDevMode;
$this->sandbox = $autentiqueDevMode?"true":"false";
$this->resourcesEnum = ResourcesEnum::class;
}
}

0 comments on commit 5fbbaf4

Please sign in to comment.