8000 Switch to authorization header by laurynas-convertapi · Pull Request #62 · ConvertAPI/convertapi-library-php · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 10000 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ If you use Composer, these dependencies should be handled automatically. If you

### Configuration

You can get your secret at https://www.convertapi.com/a
You can get your API credentials at https://www.convertapi.com/a

```php
use \ConvertApi\ConvertApi;

ConvertApi::setApiSecret('your-api-secret');
ConvertApi::setApiCredentials('your-api-secret-or-token');
```

### File conversion
Expand Down
4 changes: 2 additions & 2 deletions examples/conversions_chaining.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Short example of conversions chaining, the PDF pages extracted and saved as separated JPGs and then ZIP'ed
# https://www.convertapi.com/doc/chaining
Expand Down
4 changes: 2 additions & 2 deletions examples/convert_stream.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Example of converting content stream to PDF
# https://www.convertapi.com/txt-to-pdf
Expand Down
4 changes: 2 additions & 2 deletions examples/convert_url_to_pdf.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Example of converting Web Page URL to PDF file
# https://www.convertapi.com/web-to-pdf
Expand Down
4 changes: 2 additions & 2 deletions examples/convert_word_to_pdf_and_png.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Example of saving Word docx to PDF and to PNG
# https://www.convertapi.com/docx-to-pdf
Expand Down
4 changes: 2 additions & 2 deletions examples/create_pdf_thumbnail.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Example of extracting first page from PDF and then chaining conversion PDF page to JPG.
# https://www.convertapi.com/pdf-to-extract
Expand Down
4 changes: 2 additions & 2 deletions examples/error_handling.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

try {
$result = ConvertApi::convert('svg', ['File' => 'files/test.docx']);
Expand Down
4 changes: 2 additions & 2 deletions examples/retrieve_user_information.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
Conve B8DB rtApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Retrieve user information
# https://www.convertapi.com/doc/user
Expand Down
4 changes: 2 additions & 2 deletions examples/split_and_merge_pdf.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

use \ConvertApi\ConvertApi;

# set your api secret
ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
# set your api secret or token
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));

# Example of extracting first and last pages from PDF and then merging them back to new PDF.
# https://www.convertapi.com/pdf-to-split
Expand Down
7 changes: 5 additions & 2 deletions lib/ConvertApi/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,15 @@ private function parseResponse($response)

private function url($path)
{
return ConvertApi::$apiBase . $path . '?secret=' . ConvertApi::getApiSecret();
return ConvertApi::$apiBase . $path;
}

private function defaultHeaders()
{
return ['Accept: application/json'];
return [
'Accept: application/json',
'Authorization: Bearer ' . ConvertApi::getApiCredentials(),
];
}

private function userAgent()
Expand Down
18 changes: 9 additions & 9 deletions lib/ConvertApi/ConvertApi.php
Original B8DB file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ class ConvertApi
// ConvertAPI client version.
const VERSION = '2.0.1';

// @var string The Convert API secret. You can get your secret at https://www.convertapi.com/a
public static $apiSecret;
// @var string The Convert API credentials. You can get your credentials at https://www.convertapi.com/a
public static $apiCredentials;

// @var string The base URL for the Convert API
public static $apiBase = 'https://v2.convertapi.com/';
Expand All @@ -40,21 +40,21 @@ class ConvertApi
private static $_client;

/**
* @return string The API secret used for requests.
* @return string The API credentials used for requests.
*/
public static function getApiSecret()
public static function getApiCredentials()
{
return self::$apiSecret;
return self::$apiCredentials;
}

/**
* Sets API secret used for requests.
* Sets API secret or token used for requests.
*
* @param string $apiSecret
* @param string $apiCredentials
*/
public static function setApiSecret($apiSecret)
public static function setApiCredentials($apiCredentials)
{
self::$apiSecret = $apiSecret;
self::$apiCredentials = $apiCredentials;
}

/**
Expand Down
10 changes: 5 additions & 5 deletions tests/ConvertApi/ConvertApiTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ class ConvertApiTest extends \PHPUnit\Framework\TestCase
protected function setUp(): void
{
// Save original values so that we can restore them after running tests
$this->origApiSecret = ConvertApi::getApiSecret();
$this->origApiCredentials = ConvertApi::getApiCredentials();
$this->origApiBase = ConvertApi::getApiBase();
$this->origUploadTimeout = ConvertApi::$uploadTimeout;

ConvertApi::setApiSecret(getenv('CONVERT_API_SECRET'));
ConvertApi::setApiCredentials(getenv('CONVERT_API_SECRET'));
}

protected function tearDown(): void
{
// Restore original values
ConvertApi::setApiSecret($this->origApiSecret);
ConvertApi::setApiCredentials($this->origApiCredentials);
ConvertApi::setApiBase($this->origApiBase);
ConvertApi::$uploadTimeout = $this->origUploadTimeout;
}

public function testConfigurationAccessors()
{
ConvertApi::setApiSecret('test-secret');
$this->assertEquals('test-secret', ConvertApi::getApiSecret());
ConvertApi::setApiCredentials('test-secret');
$this->assertEquals('test-secret', ConvertApi::getApiCredentials());

ConvertApi::setApiBase('https://foo.bar');
$this->assertEquals('https://foo.bar', ConvertApi::getApiBase());
Expand Down
0