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 Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: marketplace/eqp/v1/users.md
+67-59Lines changed: 67 additions & 59 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,8 @@ profile. You must create a new profile on the [Developer Portal](https://develop
11
11
12
12
## Profile
13
13
14
-
You must use the `mage_id` associated with the client application in your developer account when making request to these endpoints. You can get this ID when obtaining a [session token](auth.html#session-token).
14
+
You must use the `mage_id` associated with the client application in your developer account when making
15
+
requests to these endpoints. You can get this ID when obtaining a [session token](auth.html#session-token).
15
16
16
17
```http
17
18
GET /rest/v1/users/:mage_id
@@ -21,7 +22,8 @@ PUT /rest/v1/users/:mage_id
21
22
22
23
### Get profile data
23
24
24
-
By default, requests for profile data return all fields. You can limit the amount of data that the request returns by using the `style=summary` option.
25
+
By default, requests for profile data return all fields.
26
+
You can limit the amount of data that the request returns by using the `style=summary` option.
25
27
26
28
The following example shows the request/response body for retrieving all profile data:
@@ -169,25 +171,26 @@ The following example shows a request to update the personal profile bio field:
169
171
170
172
```json
171
173
{
172
-
“action” : “publish”,
173
-
“personal_profile” : {
174
-
“bio” : “I can make a fire by rubbing two ice cubes.”
174
+
"action" : "publish",
175
+
"personal_profile" : {
176
+
"bio" : "I can make a fire by rubbing two ice cubes."
175
177
}
176
178
}
177
179
```
178
180
179
181
The `action` field specifies which update operation to perform:
180
182
181
-
*`publish`—The default if not specified. Publishes the profile to the relevant [Marketplace Store Partners page](https://marketplace.magento.com/partners.html).
182
-
*`draft`—The update is saved on the Developer Portal, but not published.
183
+
*`publish`— The default if not specified. Publishes the profile to the relevant
184
+
[Marketplace Store Partners page](https://marketplace.magento.com/partners.html).
185
+
*`draft`— The update is saved on the Developer Portal, but not published.
|type| string | no | Type of keys requested:'m1' - Magento 1 product keys, 'm2' - Magento 2 composer repo keys, 'all' - Both M1 and M2 keys (default) |
220
-
| label | string | no | The url encoded value of the key label; only valid for'm2' type.|
222
+
| type | string | no | Type of keys requested:<br>`m1` — Magento 1 product keys<br>`m2` — Magento 2 composer repo keys<br>`all` — Both M1 and M2 keys (default)
223
+
| label | string | no | The url encoded value of the key label; only valid for `m2` type.|
221
224
{:.style="table-layout: auto;"}
222
225
223
226
The following example shows the request/response body for retrieving keys without any query parameters:
* Each Composer key-pair has unique `label` and `is_enabled` flags to indicate whether the key is enabled.
264
-
* A Composer key-pair is identified by `user_key` (username) and `password_key` (password) when prompted for Composer credentials.
267
+
* A Composer key-pair is identified by `user_key` (username) and
268
+
`password_key` (password) when prompted for Composer credentials.
265
269
266
270
#### Magento 1 keys
267
271
268
-
* Provides a list of product names and associated product keys, which can be used in the Magento Connect Manager to install extensions.
272
+
* Provides a list of product names and associated product keys,
273
+
which can be used in the Magento Connect Manager to install extensions.
269
274
* You cannot create, update, or delete these keys.
270
275
271
276
### Create keys
272
277
273
-
Use this API to create new Magento 2 Composer key-pairs. You must specify a unique label foreach key. You can create multiple key-pairsin a single request.
278
+
Use this API to create new Magento 2 Composer key-pairs. You must specify a unique label for each key.
279
+
You can create multiple key-pairs in a single request.
274
280
275
281
```http
276
282
POST /rest/v1/users/:mage_id/keys
@@ -295,7 +301,7 @@ POST /rest/v1/users/:mage_id/keys
@@ -383,7 +390,8 @@ A 204 No Content HTTP response code indicates a successful update.
383
390
384
391
## Reports
385
392
386
-
Use this API to retrieve reports owned by a specific user. Reports contain information about extensions sales, payout status, aggregate sales, refund data, and more.
393
+
Use this API to retrieve reports owned by a specific user.
394
+
Reports contain information about extensions sales, payout status, aggregate sales, refund data, and more.
387
395
388
396
```http
389
397
GET /rest/v1/users/:mage_id/reports/pageviews
@@ -393,4 +401,4 @@ GET /rest/v1/users/:mage_id/reports/refunds
393
401
```
394
402
395
403
{: .bs-callout-info }
396
-
The Reports API specification is under design review. More details will be announced in the future..
404
+
The Reports API specification is under design review. More details will be announced in the future.
0 commit comments