Merge pull request #87 from ConvertAPI/feature/api-credentials

laurynas-convertapi · web-flow · commit 3fc2cbe5117c · 2024-09-14T11:16:06.000+03:00
Switch to authorization header
diff --git a/README.md b/README.md
@@ -16,26 +16,26 @@ npm install convertapi --save
 
 ## Usage
 
-The package needs to be configured with your account's secret key which is available at https://www.convertapi.com/a
+The package needs to be configured with your account's secret key or token which is available at https://www.convertapi.com/a
 
 Require it with the key's value:
 
 ```javascript
-var convertapi = require('convertapi')('your-api-secret');
+var convertapi = require('convertapi')('your-api-secret-or-token');
 ```
 
 Or using ES modules:
 
 ```javascript
 import ConvertAPI from 'convertapi';
 
-const convertapi = new ConvertAPI('your-api-secret');
+const convertapi = new ConvertAPI('your-api-secret-or-token');
 ```
 
 You can specify additional options, like proxy configuration and timeouts, when initializing the client:
 
 ```javascript
-var convertapi = require('convertapi')('your-api-secret', {
+var convertapi = require('convertapi')('your-api-secret-or-token', {
   conversionTimeout: 60,
   uploadTimeout: 60,
   downloadTimeout: 60,
@@ -54,7 +54,7 @@ var convertapi = require('convertapi')('your-api-secret', {
 If using ES module:
 
 ```javascript
-const convertapi = new ConvertAPI('your-api-secret', { conversionTimeout: 60 });
+const convertapi = new ConvertAPI('your-api-secret-or-token', { conversionTimeout: 60 });
 ```
 
 ### File conversion
diff --git a/examples/alternative_converter.js b/examples/alternative_converter.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of saving Word docx to PDF using OpenOffice converter
diff --git a/examples/conversion_chaining.js b/examples/conversion_chaining.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Short example of conversions chaining, the PDF pages extracted and saved as separated JPGs and then ZIP'ed
diff --git a/examples/convert_base64_content.js b/examples/convert_base64_content.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of using buffer and stream to convert base64 encoded content to pdf
diff --git a/examples/convert_stream.js b/examples/convert_stream.js
@@ -2,7 +2,7 @@
 
 var fs = require('fs');
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of using readable stream to convert to pdf
diff --git a/examples/convert_url_to_pdf.js b/examples/convert_url_to_pdf.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of converting Web Page URL to PDF file
diff --git a/examples/convert_word_to_pdf_and_png.js b/examples/convert_word_to_pdf_and_png.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of saving Word docx to PDF and to PNG
diff --git a/examples/create_pdf_thumbnail.js b/examples/create_pdf_thumbnail.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of extracting first page from PDF and then chaining conversion PDF page to JPG.
diff --git a/examples/get_result_file_stream.js b/examples/get_result_file_stream.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of converting Web Page URL to PDF and reading file data as string
diff --git a/examples/retrieve_user_information.js b/examples/retrieve_user_information.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Retrieve user information
diff --git a/examples/split_and_merge_pdf.js b/examples/split_and_merge_pdf.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-// set your api secret
+// set your api secret or token
 var convertapi = require('../lib')(process.env.CONVERT_API_SECRET);
 
 // Example of extracting first and last pages from PDF and then merging them back to new PDF.
diff --git a/index.d.ts b/index.d.ts
@@ -40,7 +40,7 @@ export interface Client {
 
 export class ConvertAPI {
   client: Client;
-  constructor (secret: string, options?: Options);
+  constructor (credentials: string, options?: Options);
   convert(toFormat: string, params: object, fromFormat?: string, conversionTimeout?: number): Promise<Result>;
   getUser(): Promise<object>;
   upload(source: string | NodeJS.ReadableStream, fileName?: string): Promise<UploadResult>;
diff --git a/src/client.js b/src/client.js
@@ -11,6 +11,7 @@ export default class Client {
     this.defaultHeader = {
       'User-Agent': api.userAgent,
       'Content-Type': 'application/x-www-form-urlencoded',
+      Authorization: `Bearer ${api.credentials}`,
       Accept: 'application/json',
     };
     this.httpsAgent = new https.Agent({ keepAlive: api.keepAlive });
@@ -93,7 +94,7 @@ export default class Client {
   }
 
   url(path) {
-    return `${this.api.baseUri}${path}?secret=${this.api.secret}`;
+    return `${this.api.baseUri}${path}`;
   }
 
   buildOptions(options) {
diff --git a/src/index.js b/src/index.js
@@ -4,12 +4,12 @@ import Task from './task';
 import Client from './client';
 import { getReadableStream, normalizeBaseUri } from './utils';
 
-function ConvertAPI(secret, options = {}) {
+function ConvertAPI(credentials, options = {}) {
   if (!(this instanceof ConvertAPI)) {
-    return new ConvertAPI(secret, options);
+    return new ConvertAPI(credentials, options);
   }
 
-  this.secret = secret;
+  this.credentials = credentials;
   this.baseUri = normalizeBaseUri(options.baseUri || 'https://v2.convertapi.com/');
   this.conversionTimeout = options.conversionTimeout;
   this.conversionTimeoutDelta = options.conversionTimeoutDelta || 10;
diff --git a/test/index.js b/test/index.js
@@ -10,12 +10,12 @@ const api = new ConvertAPI(process.env.CONVERT_API_SECRET);
 
 describe('ConvertAPI', () => {
   it('should be accessible as function', () => {
-    expect(ConvertAPI('test').secret).to.equal('test');
+    expect(ConvertAPI('test').credentials).to.equal('test');
   });
 
-  it('should assign secret', () => {
+  it('should assign credentials', () => {
     const expectedVal = process.env.CONVERT_API_SECRET;
-    expect(api.secret).to.equal(expectedVal);
+    expect(api.credentials).to.equal(expectedVal);
   });
 
   it ('should upload file', () => {
