csv_export_documentation:csv_request_and_response
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
csv_export_documentation:csv_request_and_response [2019/04/29 18:05] florian [Response] |
csv_export_documentation:csv_request_and_response [2020/06/16 15:53] (current) amil |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Export documentation: CSV format ===== | + | ===== Export documentation: CSV parameters and response===== |
| Due to run-time restrictions, an export must be sequentially callable.\\ | Due to run-time restrictions, an export must be sequentially callable.\\ | ||
| - | For this purpose, a start URL must be provided. The next URL to be called is indicated by ''Location''-Header (HTTP location).((This start URL can be entered in the FINDOLOGIC customer account in the export URL field under "Settings" –> "Import/Export" –> "Export".))\\ | + | For this purpose, a start URL must be provided. The next URL to be called is indicated by ''Location''-Header (HTTP location).((This start URL can be entered in the Findologic customer account in the export URL field under "Settings" –> "Import/Export" –> "Export".))\\ |
| This redirection is followed until a ''Location''-Header is no longer returned. | This redirection is followed until a ''Location''-Header is no longer returned. | ||
| Line 16: | Line 16: | ||
| * Determines the interval size / number of items to be exported. | * Determines the interval size / number of items to be exported. | ||
| * ''shopkey'' | * ''shopkey'' | ||
| - | * Determines the corresponding FINDOLOGIC service for the items to be exported. | + | * Determines the corresponding Findologic service for the items to be exported. |
| - | * A separate FINDOLOGIC service is required for each language and subshop. | + | * A separate Findologic service is required for each language and subshop. |
| * ''language'' | * ''language'' | ||
| * Determines the language of the items to be exported. | * Determines the language of the items to be exported. | ||
| + | |||
| + | <note>Please make sure to whitelist the HTTP user agent "Findologic" if you are restricting access to the export via user agents.</note> | ||
| ---- | ---- | ||
| Line 48: | Line 50: | ||
| ==== CSV file ==== | ==== CSV file ==== | ||
| - | The item data is being exported to a CSV file according to a corresponding [[export_patterns:csv|format]] \\ | + | The item data is being exported to a CSV file according to a corresponding [[csv_export_documentation:csv_format|format]]. \\ |
| The file name has to be put out after the export (see example below). | The file name has to be put out after the export (see example below). | ||
| Line 54: | Line 56: | ||
| === Directory === | === Directory === | ||
| - | The CSV file has to be created in the usual directory for exports, that is defined in the shop system or (if not available) in the export path, which is set in the shop-backend. | + | The CSV file has to be created in the usual directory for exports that is defined in the shop system or (if not available) in the export path, which is set in the shop-backend. |
| \\ | \\ | ||
| Line 79: | Line 81: | ||
| - Start | - Start | ||
| - | * The export URL is called by FINDOLOGIC with the parameters described above. | + | * The export URL is called by Findologic with the parameters described above. |
| * Call: ''<nowiki>http://www.example.com/findologic_export.php?start=0&limit=100&language=de&shopkey=ABCDABCDABCDABCDABCDABCDABCDABCD</nowiki>'' | * Call: ''<nowiki>http://www.example.com/findologic_export.php?start=0&limit=100&language=de&shopkey=ABCDABCDABCDABCDABCDABCDABCDABCD</nowiki>'' | ||
| - Initialisation | - Initialisation | ||
| Line 88: | Line 90: | ||
| * The items are exported to the ''CSV-file''. | * The items are exported to the ''CSV-file''. | ||
| - Response | - Response | ||
| - | * A forward to the next item interval is returned. | + | * A redirect to the next page is returned. |
| * <code>HTTP/1.1 302 Found | * <code>HTTP/1.1 302 Found | ||
| Location: http://www.mein-shop.de/findologic_export.php?start=100&limit=100&language=de&shopkey=ABCDABCDABCDABCDABCDABCDABCDABCD | Location: http://www.mein-shop.de/findologic_export.php?start=100&limit=100&language=de&shopkey=ABCDABCDABCDABCDABCDABCDABCDABCD | ||
| Line 96: | Line 98: | ||
| * The value of the ''start'' parameter is the respective value of the last ''start'' parameter plus the value of the limit parameter. | * The value of the ''start'' parameter is the respective value of the last ''start'' parameter plus the value of the limit parameter. | ||
| * The value of the ''limit'' parameter remains the same. | * The value of the ''limit'' parameter remains the same. | ||
| - | - Repetition from Item 3 | + | - Repeat until all products are exported. Stop redirecting then. |
| - | - Completion | + | |
| * If the last item has been exported, the relevant status message is put out: | * If the last item has been exported, the relevant status message is put out: | ||
| * <code>HTTP/1.1 200 OK | * <code>HTTP/1.1 200 OK | ||
| Line 105: | Line 106: | ||
| FILE: <PFAD_ZUR_CSV>/<CSV_DATEINAME></code> | FILE: <PFAD_ZUR_CSV>/<CSV_DATEINAME></code> | ||
| - Download | - Download | ||
| - | * The ''CSV'' just created is imported by FINDOLOGIC. | + | * The ''CSV'' just created is imported by Findologic. |
| - | * The product indexing is started by FINDOLOGIC. | + | * The product indexing is started by Findologic. |
| ---- | ---- | ||
| Line 136: | Line 137: | ||
| === .htaccess protection === | === .htaccess protection === | ||
| - | The export script can also be in a .htaccess-protected area. For this purpose, you can store a user name and password in the FINDOLOGIC customer account under //Settings -> Import/Export -> Export Settings//. | + | The export script can also be in a .htaccess-protected area. For this purpose, you can store a user name and password in the Findologic customer account under //Settings -> Import/Export -> Export Settings//. |
| \\ | \\ | ||
| Line 142: | Line 143: | ||
| === Load-Balancing === | === Load-Balancing === | ||
| - | If you use load-balancing in your infrastructure, please ensure, that export calls are always forwarded to the same host or to a host that is outside the cluster. Otherwise the export cannot be completely generated. | + | If you use load-balancing in your infrastructure, please ensure, that export calls are always forwarded to the same host or to a host that is outside the cluster. Otherwise the export cannot be completely generated because of the redirect chain. |
| \\ | \\ | ||