Adds first contents for setup/testing, Order Cycle and useful links

Filipe
2025-04-13 15:02:17 +01:00
parent 61d7ce7247
commit e1086a248c

@@ -1 +1,53 @@
This section contains a first attempt to gather information on the Shopify/OFN integration, and provide an overview on features and setup steps.
This section contains a first attempt to gather information on the Shopify/OFN integration, and provide an overview on features and setup steps.
## Table of contents
* [Setup guide for testing](#setup-guide-for-testing)
* [How do I connect to DFC?](#how-to-connect)
* [Which server can I use?](#which-server-can-I-use)
* [Which account should I use?](#which-account-should-I-use)
* [How do I import products?](#how-do-I-import-products)
* [Order Cycle and Product Sync](#order-cycle-and-product-sync)
* [Order Cycle Setup](#order-cycle-setup)
* [Useful Links](#useful-links)
# Setup guide for testing
## How do I connect to DFC? :zap:
- Enable the feature toggle for connected_apps
- Visit the Connected Apps setting on the Configuration section, and check the option DFC anonymized orders API for research purposes ; Click Update.
- Visit /admin/enterprises/oidc_settings and login with the OIDC test account
![image](https://github.com/user-attachments/assets/5bdc8716-27ef-4198-a64f-998a625e9404)
## Which server can I use?
Connecting with DFC should be possible with all three available staging servers (AU, UK, FR).
## Which account should I use?
[testdfc@protonmail.com](mailto:testdfc@protonmail.com), details are on Bitwarden.
## How do I import products?
1) After connecting the staging server (or using -UK, -FR) and your account, visit the product import page.
2) Visit /admin/product_import
3) Scroll to bottom, enter URL of a DFC products endpoint, eg:
https://env-0105831.jcloud-ver-jpe.ik-server.com/api/dfc/Enterprises/test-hodmedod/SuppliedProducts
[https://staging.openfoodnetwork.org.au/api/dfc/enterprises/{id}/catalog_items](https://staging.openfoodnetwork.org.au/api/dfc/enterprises/%7Bid%7D/catalog_items) (where id is the db id of an enterprise that your user has management role for)
Select enterprise to import into
4) Click "Preview"
5) Summary should be shown with correct info.
6) Click import. The correct number of products should be imported.
# Order Cycle and Product Sync
## Order Cycle Setup
# Useful Links
- [DFC Authentication page (Les Communs/KeyCloak)](https://login.lescommuns.org/auth/realms/data-food-consortium/account/#/)
- [DFC object model](https://docs.google.com/presentation/d/157i0ySW3T89KviZHmderXl7X0ywuvtz0QunaHJcEF_Q/edit?slide=id.g39f6d554c3_0_7#slide=id.g39f6d554c3_0_7)