Skip to content

Commit 25865ea

Browse files
authored
Remove references to basic auth, link to API account creation KB
- Remove references to basic auth, as most stores no longer support it so it's confusing for someone new to the repo - Provide link to KB article on how to create an OAuth API token
1 parent 39d673e commit 25865ea

1 file changed

Lines changed: 10 additions & 17 deletions

File tree

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,7 @@ Requirements
1919
- PHP 7.0 or greater
2020
- cUrl extension enabled
2121

22-
**To connect to the API with basic auth you need the following:**
23-
24-
- Secure URL pointing to a Bigcommerce store
25-
- Username of an authorized admin user of the store
26-
- API key for the user
27-
28-
To generate an API key, go to Control Panel > Users > Edit User and make sure
29-
the 'Enable the XML API?' is ticked.
22+
To generate an OAuth API token, [follow this guide.](https://support.bigcommerce.com/s/article/Store-API-Accounts)
3023

3124
**To connect to the API with OAuth you will need the following:**
3225

@@ -72,15 +65,6 @@ in your autoload path (using Composer’s `vendor/autoload.php` hook is recommen
7265
Provide your credentials to the static configuration hook to prepare the API client
7366
for connecting to a store on the Bigcommerce platform:
7467

75-
### Basic Auth
76-
~~~php
77-
Bigcommerce::configure(array(
78-
'store_url' => 'https://store.mybigcommerce.com',
79-
'username' => 'admin',
80-
'api_key' => 'd81aada4xc34xx3e18f0xxxx7f36ca'
81-
));
82-
~~~
83-
8468
### OAuth
8569

8670
In order to obtain the auth_token you would consume `Bigcommerce::getAuthToken` method
@@ -105,6 +89,15 @@ Bigcommerce::configure(array(
10589

10690
~~~
10791

92+
### Basic Auth (deprecated)
93+
~~~php
94+
Bigcommerce::configure(array(
95+
'store_url' => 'https://store.mybigcommerce.com',
96+
'username' => 'admin',
97+
'api_key' => 'd81aada4xc34xx3e18f0xxxx7f36ca'
98+
));
99+
~~~
100+
108101
Connecting to the store
109102
-----------------------
110103

0 commit comments

Comments
 (0)