Skip to content

Commit 0a2fa9b

Browse files
Merge branch 'app-catalogs' of https://github.com/akeneo/pim-api-docs into app-catalogs
2 parents 360679c + e6e4c6c commit 0a2fa9b

File tree

7 files changed

+413
-10
lines changed

7 files changed

+413
-10
lines changed

content/apps/catalogs.md

Lines changed: 57 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22

33
## Overview
44

5+
<<<<<<< HEAD
56
This guide introduces the catalog feature and explains why using catalogs to retrieve Akeneo data.
7+
=======
8+
This guide introduces the catalog feature. With catalogs, you will save time during development because Akeneo PXM Studio
9+
will manage your **product selection** and give you direct access to the relevant data.
10+
With catalogs, you don't need to develop interfaces about filtering products, locales or attributes.
11+
>>>>>>> e6e4c6c0ebf5c8f6f6d3274d2066a8812d80227a
612
713
### What's a catalog?
814

9-
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.
15+
A catalog is a selection of products defined by one or several criteria. (families, categories, ...)
1016

11-
When your app uses catalogs to retrieve product data, it automatically enables the Catalogs tab and creates catalogs in Akeneo.
17+
Catalogs are only created by apps and are configured by Akeneo users themselves from Akeneo PXM Studio. This feature is
18+
only visible if the app manage catalogs.
19+
20+
![Catalogs](../img/apps/catalogs-list.png)
1221

1322
![Catalogs for apps](../img/apps/app-catalog-list.png)
1423

@@ -20,6 +29,13 @@ Most of the time, developers must design, develop and maintain a filter interfac
2029
Using catalogs for apps prevents you from adding this filtering interface to your app. When you retrieve product information related to a catalog, you only retrieve the data your app needs to process.
2130

2231
Moreover, with catalogs, you don't have to master the entire PIM structure anymore to deliver a relevant filtering interface, as the Akeneo PXM Studio already provides it to your users.
32+
![Product Selection](../img/apps/catalogs-product-selection.png)
33+
34+
### Limits
35+
36+
::: warning
37+
You can only create **up to 15 catalogs** per app.
38+
:::
2339

2440
### Next steps
2541

@@ -29,6 +45,11 @@ Moreover, with catalogs, you don't have to master the entire PIM structure anymo
2945
## Getting started with catalogs
3046

3147
This guide describes how to use the catalog features with your app.
48+
<!-- - Discover how users configure catalogs in the Akeneo PXM Studio TODO Add link -->
49+
50+
## Getting started with catalogs
51+
52+
To create and use a catalog, an app must send some requests to the PIM REST API.
3253

3354
### What you'll learn
3455

@@ -38,24 +59,52 @@ After completing this tutorial, you'll be able to create and use catalogs to ret
3859

3960
- You have a Partner account and a developer sandbox.
4061
- Your app already manages the authorization step
62+
- You have an app able to use the authorization process.
4163

4264
### Step 1: Ask for catalog scopes
4365

44-
<!-- TODO -->
66+
In the documentation [Ask for authorizations](/apps/authentication-and-authorization.html#step-2-ask-for-authorizations),
67+
you discovered how to ask for scopes.
68+
69+
If you want to manage catalogs, you need to ask for at least 4 scopes:
70+
- `read_products`
71+
- `read_catalogs`
72+
- `write_catalogs`
73+
- `delete_catalogs`
74+
75+
Once these scopes are accepted by Akeneo users during the installation of your app, you will be able to manage and use
76+
catalogs.
4577

4678
### Step 2: Create catalogs
4779

48-
<!-- TODO -->
80+
Checkout the [Create a new catalog](/api-reference.html#post_app_catalog) endpoint documentation to find out how
81+
to create one.
4982

5083
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.
84+
::: info
85+
You should create a catalog with the more descriptive name possible. It will help your users to know how to configure it.
86+
:::
5187

52-
::: warning
53-
You can create **up to 15 catalogs** per app.
54-
:::
88+
Catalogs created **are always disabled by default** in the Akeneo PXM Studio. Only Akeneo users are able to enable a
89+
catalog. You must wait for any of your users to enable it before using it.
90+
91+
To help your users, you can give them a link to directly access the catalog configuration interface:
92+
93+
``` http
94+
95+
https://my-pim.cloud.akeneo.com/connect/apps/v1/catalogs/{catalog id}
96+
```
97+
98+
At any moment, you can verify if the catalog is enabled by calling the [get catalog endpoint](/api-reference.html#get_app_catalog).
5599

56100
### Step 3: Get products using catalogs
57101

58-
<!-- TODO -->
102+
::: warning
103+
The endpoint for retrieving the list of product uuids will be available soon.
104+
:::
105+
106+
Once you have an enabled catalog, you will be able to paginate the corresponding product uuids using this
107+
[endpoint](/api-reference.html#Appcatalogproduct).
59108

60109
### Next steps
61110
- 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)