Skip to content

Commit e6e4c6c

Browse files
Merge pull request #623 from akeneo/CXP-1208
CXP-1208: wip docs catalogs
2 parents 650b8b7 + 22d9734 commit e6e4c6c

File tree

7 files changed

+407
-18
lines changed

7 files changed

+407
-18
lines changed

content/apps/catalogs.md

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,35 @@
22

33
## Overview
44

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.
88

99
### What's a catalog?
1010

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.
1215

13-
When your app uses catalogs to retrieve product data, it automatically enables the Catalogs tab and creates catalogs in Akeneo.
16+
![Catalogs](../img/apps/catalogs-list.png)
1417

15-
<!-- image catalog list -->
18+
![Product Selection](../img/apps/catalogs-product-selection.png)
19+
20+
### Limits
21+
22+
::: warning
23+
You can only create **up to 15 catalogs** per app.
24+
:::
1625

1726
### Next steps
1827

1928
- 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 -->
2130

2231
## Getting started with catalogs
2332

24-
<!-- `Add an introduction` -->
33+
To create and use a catalog, an app must send some requests to the PIM REST API.
2534

2635
### What you'll learn
2736

@@ -30,25 +39,51 @@ After you've completed this tutorial, you'll be able to create and use catalogs
3039
### Requirements
3140

3241
- 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.
3443

3544
### Step 1: Ask for catalog scopes
3645

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.
3857

3958
### Step 2: Create catalogs
4059

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.
4262

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+
:::
4466

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:
71+
72+
``` http
73+
74+
https://my-pim.cloud.akeneo.com/connect/apps/v1/catalogs/{catalog id}
75+
```
76+
77+
At any moment, you can verify if the catalog is enabled by calling the [get catalog endpoint](/api-reference.html#get_app_catalog).
4878

4979
### Step 3: Get products using catalogs
5080

51-
<!-- TODO -->
81+
::: warning
82+
The endpoint for retrieving the list of product uuids will be available soon.
83+
:::
84+
85+
Once you have an enabled catalog, you will be able to paginate the corresponding product uuids using this
86+
[endpoint](/api-reference.html#Appcatalogproduct).
5287

5388
### Next steps
5489
- Learn [how to synchronize Akeneo data](/getting-started/synchronize-pim-products-6x/welcome.html)

content/img/apps/catalogs-list.png

80.7 KB
Loading
82.9 KB
Loading

0 commit comments

Comments
 (0)