You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 23, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,7 @@
13
13
14
14
# Laravel - Magento API
15
15
16
-
A Magento 2 API Object Oriented wrapper for a Laravel application. Also includes an optional opinionated storage system for
17
-
consuming Magento 2 data in your Laravel application.
16
+
A Magento 2 API Object Oriented wrapper for a Laravel application. This package also includes an optional opinionated storage system for consuming Magento 2 data in your Laravel application.
18
17
19
18
## Installation
20
19
@@ -35,6 +34,8 @@ If you are wanting to store the data from the Magento API and want to use our op
> more configuration options are available in the [Manual Configuration Options](#manual-configuration-options) section.
38
+
38
39
Configure your Magento 2 API endpoint and token in your `.env` file:
39
40
```
40
41
MAGENTO_BASE_URL="https://mydomain.com"
@@ -111,6 +112,31 @@ Get a schema blueprint of the Magento 2 REST API:
111
112
$magento->api('schema')->show();
112
113
```
113
114
115
+
## Manual Configuration Options
116
+
117
+
This package features additional configuration options which uses the Magento 2 default settings. You are more than welcome to change any of the values as you need fit in your application:
118
+
119
+
### Base API Path
120
+
121
+
The Magento 2 REST API Base Path. By default, this is assigned as 'rest'. Developers should only update this setting if the path has changed:
122
+
```
123
+
MAGENTO_BASE_PATH='rest'
124
+
```
125
+
126
+
### Magento Store Code
127
+
128
+
The Magento 2 REST API Store Code By default, this is assigned to 'all' specifying all magento stores on requests. Developers may update this to specify the API around a specific store code.
129
+
```
130
+
MAGENTO_STORE_CODE='all'
131
+
```
132
+
133
+
### Magento API Version
134
+
135
+
The Magento 2 REST API Version. By default, Magento 2 sets this to 'V1'. Developers should only update this setting if the version has changed.
136
+
```
137
+
MAGENTO_API_VERSION='V1'
138
+
```
139
+
114
140
## Jobs
115
141
116
142
> In order use these queue jobs, you must have registered the migrations from the installation section noted above.
0 commit comments