Merge pull request #300 from LibreSign/feat/api-article

chore: add article about how to use the API

Author: vitormattos

config.php

@@ -122,8 +122,8 @@
             'comment' => "A simple and complete solution. It speeds up processes and can eliminate the use of paper. We integrated it with our public management system or e-Cidade, it was absurdly good. Congratulations.",
             'author' => 'Igor Afonso Oliveira Ruas'
         ],
-        
-        
+
+
     ],
     'getFromCategory' => function($page, $category) {
         $files = array_merge(
@@ -312,6 +312,15 @@
                         'linkedin' => 'https://www.linkedin.com/in/daianealvesrj/',
                     ]
                 ],
+                [
+                    'name' => 'Vitor Mattos',
+                    'gravatar' => '2656fb55188f5a28ee7a99db0b9e6d8f4b91c7f6b88eead05c57386a3a05ff49' ,
+                    'bio' => 'With over 20 years of experience as CTO of LibreCode, is a Zend Certified Engineer and expert in PHP, Linux, and FLOSS solutions. Passionate about technology, is an entrepreneur in the IT field and an activist for privacy. As a strong advocate for open-source software, frequently speaks at regional and national events, demonstrating his commitment to sharing knowledge, promoting the adoption of open technologies, and emphasizing the importance of privacy.',
+                    'role' => 'CTO',
+                    'social' => [
+                        'linkedin' => 'https://www.linkedin.com/in/vitormattos/',
+                    ]
+                ],
             ],
         ],
     ],

lang/en/main.json

@@ -0,0 +1,29 @@
+---
+extends: _layouts.post
+title: LibreSign API Guide
+author: Vitor Mattos
+date: 2024-10-10
+description: Provides a practical guide on how to use the LibreSign API, including querying endpoints and understanding usage flows by observing requests in the application.
+categories: [features]
+icon: dashboard
+---
+
+# LibreSign API: Endpoints and usage flows
+
+## API Endpoints
+
+To find out which endpoints are available in the LibreSign API, follow these steps:
+
+1. **Install the OCS API Viewer App**: Start by installing the [OCS API Viewer](https://apps.nextcloud.com/apps/ocs_api_viewer) in your Nextcloud environment.
+2. **Access the API Documentation**: In the Nextcloud menu, locate the OCS app. Here, you will find the documentation for the LibreSign API, as well as other Nextcloud APIs.
+
+## Understanding the LibreSign API usage flows
+
+To understand how to perform specific operations, such as requesting a signature, you can use the LibreSign application itself as a reference. Here’s how to do it:
+
+1. **Open Developer Tools**: Press the F12 key in your browser to access the developer tools.
+2. **Go to the Network Tab**: Navigate to the "Network" tab to monitor the API requests.
+3. **Filter the requests**: Use the filter to show only the requests related to LibreSign by typing "libresign."
+4. **Perform actions in LibreSign**: Execute the desired actions in the LibreSign application. Observe the requests sent to the API at each step and analyze how they are structured.
+
+By following these steps, you will be able to query the available endpoints of the LibreSign API and understand the usage flows by monitoring the requests made by the application. This will help you integrate and use the API in your projects.