xml_export_documentation:xml_request_and_response
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
xml_export_documentation:xml_request_and_response [2019/05/22 12:36] fe80:6838:8204:7241:6aa9:419b:de43:27ef ↷ Links adapted because of a move operation |
xml_export_documentation:xml_request_and_response [2020/06/16 15:47] amil |
||
---|---|---|---|
Line 1: | Line 1: | ||
===== Export documentation: XML request and response===== | ===== Export documentation: XML request and response===== | ||
- | The goal of the export is to transfer all products to the FINDOLOGIC-server so FINDOLOGIC can index them. To achieve this, there has to be a file or function-call reachable from the outside under ''findologic_export.php'' in the root of the shop.((The path can be changed if necessary.)) | + | The goal of the export is to transfer all products to the Findologic-server so Findologic can index them. To achieve this, there has to be a file or function-call reachable from the outside under ''findologic_export.php'' in the root of the shop.((The path can be changed if necessary.)) |
---- | ---- | ||
==== Parameter of the Export-URL ==== | ==== Parameter of the Export-URL ==== | ||
- | For the sequential processing of the export ((Due to runtime limitations the export has to be paginated.)) the following parameters have to be transmitted: | + | For the sequential processing of the export the following parameters have to be transmitted: |
* ''shopkey'': shopkey of the service | * ''shopkey'': shopkey of the service | ||
* ''start'': first exported article (Offset) starting with ''0'' | * ''start'': first exported article (Offset) starting with ''0'' | ||
* ''count'': page size / how many articles are exported per page | * ''count'': page size / how many articles are exported per page | ||
+ | |||
+ | <note important>Due to runtime limitations the XML-export has to be paginated.</note> | ||
All other parameters given in the export URL are passed through each export step. | All other parameters given in the export URL are passed through each export step. | ||
Line 24: | Line 26: | ||
==== Procedure of the Export ==== | ==== Procedure of the Export ==== | ||
- | The export call delivers [[xml_export_documentation:xml_format|valid XML]] for the respective products. The XML also contains the information if more products are delivered, thus FINDOLOGIC can send another call. | + | The export call delivers [[xml_export_documentation:xml_format|valid XML]] for the respective products. The XML also contains the information if more products are delivered, thus Findologic can send another call. |
- | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=0&count=100 from the FINDOLOGIC-import | + | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=0&count=100 from the Findologic-import |
- Return of the XML for the first 100 products (including the information that there will be more). | - Return of the XML for the first 100 products (including the information that there will be more). | ||
- | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=100&count=100 from the FINDOLOGIC-import | + | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=100&count=100 from the Findologic-import |
- Return of the XML for the next 100 products (including the information that there will be more). | - Return of the XML for the next 100 products (including the information that there will be more). | ||
- | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=200&count=100 from the FINDOLOGIC-import | + | - Call http://www.example.com/findologic_export.php?shopkey=1234&start=200&count=100 from the Findologic-import |
- More calls ... | - More calls ... | ||
- Return of the last export-page (''total'' number of products is exported) | - Return of the last export-page (''total'' number of products is exported) | ||
- Indexing of all products | - Indexing of all products | ||
+ | |||
+ | <note>Please make sure to whitelist the HTTP user agent "Findologic" if you are restricting access to the export via user agents.</note> | ||
---- | ---- |