feat: add support for API key authentication alongside JWT tokens

Author: ralyodio

examples/README.md

@@ -100,12 +100,22 @@ const API_BASE_URL = 'http://localhost:3000'; // Change as needed
 
 ### Authentication
 
-Replace the placeholder token in each example:
+There are two ways to authenticate with the API:
+
+1. **JWT Tokens** - Use the Authorization header with Bearer prefix:
+
+```javascript
+'Authorization': 'Bearer YOUR_JWT_TOKEN_HERE'
+```
+
+2. **API Keys** - Use the X-API-Key header:
 
 ```javascript
-'Authorization': 'Bearer YOUR_ACTUAL_TOKEN_HERE'
+'X-API-Key': 'YOUR_API_KEY_HERE'  // API keys start with 'pfs_'
 ```
 
+> **Important**: API keys should be sent in the X-API-Key header, not in the Authorization header.
+
 ### File Paths
 
 Update file paths to point to your actual documents:
@@ -154,7 +164,10 @@ Each example will:
 
 ### Common Issues
 
-1. **Authentication Error**: Check your bearer token
+1. **Authentication Error**:
+   - For JWT tokens: Ensure your token is valid and sent in the Authorization header
+   - For API keys: Make sure to use the X-API-Key header (not Authorization) for API keys
+   - API keys should start with 'pfs_' and be sent without any 'Bearer' prefix
 2. **Server Connection**: Verify the API_BASE_URL and server status
 3. **File Not Found**: Check file paths and permissions
 4. **Conversion Failed**: Some formats have limitations (see above)

examples/test-document-to-markdown-endpoints.js

@@ -27,7 +27,11 @@ async function testPdfToMarkdown() {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        'Authorization': 'Bearer YOUR_AUTH_TOKEN' // Replace with actual token
+        // Use one of the following authentication methods:
+        // 1. For JWT tokens:
+        'Authorization': 'Bearer YOUR_JWT_TOKEN', // Replace with actual JWT token
+        // 2. For API keys (comment out the Authorization header above and use this instead):
+        // 'X-API-Key': 'YOUR_API_KEY' // Replace with actual API key (starts with pfs_)
       },
       body: JSON.stringify({
         file: testPdfBase64,
@@ -270,7 +274,10 @@ async function runTests() {
 
   console.log('\n✨ All tests completed!');
   console.log('\nNote: To run actual tests, you need to:');
-  console.log('1. Replace YOUR_AUTH_TOKEN with a valid authentication token');
+  console.log('1. Choose an authentication method:');
+  console.log('   a. For JWT tokens: Replace YOUR_JWT_TOKEN with a valid JWT token');
+  console.log('   b. For API keys: Comment out the Authorization header and uncomment the X-API-Key header');
+  console.log('      Then replace YOUR_API_KEY with a valid API key (starts with pfs_)');
   console.log('2. Replace the test base64 content with actual file content');
   console.log('3. Ensure the server is running on the correct port');
 }

examples/xlsx-to-markdown-example.js

@@ -32,7 +32,11 @@ async function convertXlsxToMarkdown(xlsxBase64, filename, store = false) {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        'Authorization': 'Bearer YOUR_AUTH_TOKEN' // Replace with actual token
+        // Use one of the following authentication methods:
+        // 1. For JWT tokens:
+        'Authorization': 'Bearer YOUR_JWT_TOKEN', // Replace with actual JWT token
+        // 2. For API keys (comment out the Authorization header above and use this instead):
+        // 'X-API-Key': 'YOUR_API_KEY' // Replace with actual API key (starts with pfs_)
       },
       body: JSON.stringify({
         file: xlsxBase64,
@@ -95,7 +99,10 @@ async function runExample() {
   console.log('🧪 XLSX to Markdown Conversion Example\n');
 
   console.log('📋 Setup Instructions:');
-  console.log('1. Replace YOUR_AUTH_TOKEN with a valid authentication token');
+  console.log('1. Choose an authentication method:');
+  console.log('   a. For JWT tokens: Replace YOUR_JWT_TOKEN with a valid JWT token');
+  console.log('   b. For API keys: Comment out the Authorization header and uncomment the X-API-Key header');
+  console.log('      Then replace YOUR_API_KEY with a valid API key (starts with pfs_)');
   console.log('2. Place an XLSX file named "sample-spreadsheet.xlsx" in this directory, or');
   console.log('3. Replace sampleXlsxBase64 with actual XLSX content in base64 format');
   console.log('4. Ensure the server is running on the correct port\n');