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
Copy file name to clipboardExpand all lines: content/apps/catalogs.md
+51-16Lines changed: 51 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,35 @@
2
2
3
3
## Overview
4
4
5
-
<!-- TODO -->
6
-
7
-
This guide introduces the catalog feature, which avoids you to add a filtering interface to your app as Akeneo PXM Studio already does it.
5
+
This guide introduces the catalog feature. With catalogs, you will save time during development because Akeneo PXM Studio
6
+
will manage your **product selection** and give you direct access to the relevant data.
7
+
With catalogs, you don't need to develop interfaces about filtering products, locales or attributes.
8
8
9
9
### What's a catalog?
10
10
11
-
With catalogs, Akeneo users can configure which products they want to share with your app thanks to a **product selection** composed of one or several criteria that allow you to filter products.
11
+
A catalog is a selection of products defined by one or several criteria. (families, categories, ...)
12
+
13
+
Catalogs are only created by apps and are configured by Akeneo users themselves from Akeneo PXM Studio. This feature is
14
+
only visible if the app manage catalogs.
12
15
13
-
When your app uses catalogs to retrieve product data, it automatically enables the Catalogs tab and creates catalogs in Akeneo.
You can only create **up to 15 catalogs** per app.
24
+
:::
16
25
17
26
### Next steps
18
27
19
28
- Learn [how to create and use catalogs](/apps/catalogs.html#getting-started-with-catalogs)
20
-
-Discover how users configure catalogs in the Akeneo PXM Studio<!-- TODO Add link -->
29
+
<!-- - Discover how users configure catalogs in the Akeneo PXM Studio TODO Add link -->
21
30
22
31
## Getting started with catalogs
23
32
24
-
<!-- `Add an introduction` -->
33
+
To create and use a catalog, an app must send some requests to the PIM REST API.
25
34
26
35
### What you'll learn
27
36
@@ -30,25 +39,51 @@ After you've completed this tutorial, you'll be able to create and use catalogs
30
39
### Requirements
31
40
32
41
- You have a Partner account and a developer sandbox.
33
-
-Your app already manages the authentication step
42
+
-You have an app able to use the authorization process.
34
43
35
44
### Step 1: Ask for catalog scopes
36
45
37
-
<!-- TODO -->
46
+
In the documentation [Ask for authorizations](/apps/authentication-and-authorization.html#step-2-ask-for-authorizations),
47
+
you discovered how to ask for scopes.
48
+
49
+
If you want to manage catalogs, you need to ask for at least 4 scopes:
50
+
-`read_products`
51
+
-`read_catalogs`
52
+
-`write_catalogs`
53
+
-`delete_catalogs`
54
+
55
+
Once these scopes are accepted by Akeneo users during the installation of your app, you will be able to manage and use
56
+
catalogs.
38
57
39
58
### Step 2: Create catalogs
40
59
41
-
<!-- TODO -->
60
+
Checkout the [Create a new catalog](/api-reference.html#post_app_catalog) endpoint documentation to find out how
61
+
to create one.
42
62
43
-
By default, when you create a catalog in the Akeneo PXM Studio, the catalog is disabled. It means that, until a user hasn't enabled it, you won't be able to retrieve products for this catalog. Note that only users can enable a catalog.
63
+
::: info
64
+
You should create a catalog with the more descriptive name possible. It will help your users to know how to configure it.
65
+
:::
44
66
45
-
::: warning
46
-
You can create **up to 15 catalogs** per app.
47
-
:::
67
+
Catalogs created **are always disabled by default** in the Akeneo PXM Studio. Only Akeneo users are able to enable a
68
+
catalog. You must wait for any of your users to enable it before using it.
69
+
70
+
To help your users, you can give them a link to directly access the catalog configuration interface:
0 commit comments