integration_documentation:request
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
integration_documentation:request [2019/12/05 16:02] florian |
integration_documentation:request [2022/05/12 11:37] (current) florian [Service-URL] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Request to FINDOLOGIC ===== | + | ===== Request to Findologic ===== |
- | In this article the request to FINDOLOGIC with all important parameters and information regarding the request is documented. \\ | + | In this article the request to Findologic with all important parameters and information regarding the request is documented. \\ |
If any questions occur, please contact our technical support [[support@findologic.com]]. | If any questions occur, please contact our technical support [[support@findologic.com]]. | ||
+ | |||
+ | <note tip>Our library helps requesting the Findologic API and also getting the data from the response and mapping it to corresponding objects. Read more at https://github.com/findologic/findologic-api </note> | ||
----- | ----- | ||
Line 8: | Line 10: | ||
==== Short overview ==== | ==== Short overview ==== | ||
- | * The FINDOLOGIC search service is only available after the first succeeded import. | + | * The Findologic search service is only available after the first succeeded import. |
- | * Queries are sent to FINDOLOGIC by means of HTTP requests. | + | * Queries are sent to Findologic by means of HTTP requests. |
* Before **each** actual query, a so-called //Alivetest// must be performed. | * Before **each** actual query, a so-called //Alivetest// must be performed. | ||
* The //Alivetest// returns either ''alive'' or ''dead''. If ''dead'' is the case, a fallback mechanism must take effect, and the conventional shop search must process the query. | * The //Alivetest// returns either ''alive'' or ''dead''. If ''dead'' is the case, a fallback mechanism must take effect, and the conventional shop search must process the query. | ||
Line 17: | Line 19: | ||
==== Fallback mechanism ==== | ==== Fallback mechanism ==== | ||
- | * Before each query, an //Alivetest// HTTP request is sent to FINDOLOGIC according to the following pattern: | + | * Before each query, an //Alivetest// HTTP request is sent to Findologic according to the following pattern: |
* ''%%http://service.findologic.com/ps/<SHOP_URL>/alivetest.php?shopkey=<SHOPKEY>%%''. | * ''%%http://service.findologic.com/ps/<SHOP_URL>/alivetest.php?shopkey=<SHOPKEY>%%''. | ||
- | * In the case of a response from ''alive'', the actual query is sent to the FINDOLOGIC service. | + | * In the case of a response from ''alive'', the actual query is sent to the Findologic service. |
- | * With all other responses other than ''alive'', the query is processed by the conventional shop search. \\ If the fallback mechanism is not working properly, the FINDOLOGIC search **may not** be used in a productive shop. | + | * With all other responses other than ''alive'', the query is processed by the conventional shop search. \\ If the fallback mechanism is not working properly, the Findologic search **may not** be used in a productive shop. |
* Also, a timeout of 1 second must be set for the //Alivetest//. If the response time exceeds 1 second, the query is processed by the conventional shop search. | * Also, a timeout of 1 second must be set for the //Alivetest//. If the response time exceeds 1 second, the query is processed by the conventional shop search. | ||
* A timeout of 3 seconds must be set for the actual query. If the response time exceeds 3 seconds, the query is processed by the conventional shop search. | * A timeout of 3 seconds must be set for the actual query. If the response time exceeds 3 seconds, the query is processed by the conventional shop search. | ||
Line 31: | Line 33: | ||
* **[[#service-url|Service-URL]]** | * **[[#service-url|Service-URL]]** | ||
- | * **[[#required_parameters|Required parameters]]** | + | * **[[integration_documentation:parameters#required_parameters|Required parameters]]** |
* ''shopkey'' | * ''shopkey'' | ||
* ''shopurl'' | * ''shopurl'' | ||
Line 37: | Line 39: | ||
* ''referer'' | * ''referer'' | ||
* ''revision'' | * ''revision'' | ||
- | * **[[#search_parameter|Search parameters]]** | + | * **[[integration_documentation:parameters#search_parameters|Search parameters]]** |
* ''query'' | * ''query'' | ||
* ''attrib[]'' | * ''attrib[]'' | ||
Line 44: | Line 46: | ||
* ''outputAttrib[]'' | * ''outputAttrib[]'' | ||
* ''pushAttrib[][]'' | * ''pushAttrib[][]'' | ||
- | * **[[#limiting_paging_parameters|Restriction / paging parameters]]** | + | * **[[integration_documentation:parameters#limiting_paging_parameters|Restriction / paging parameters]]** |
* ''count'' | * ''count'' | ||
* ''first'' | * ''first'' | ||
Line 52: | Line 54: | ||
---- | ---- | ||
- | ==== Service-URL ==== | ||
- | |||
- | The FINDOLOGIC search service must be addressed under the service URL. \\ | ||
- | You can find the URL in the customer account -> Account -> Master data. Or by clicking | ||
- | [[https://secure.findologic.com/login.symfony/web/app.php/shop/core|here]]. | ||
- | |||
- | ---- | ||
==== Generating the request URL ==== | ==== Generating the request URL ==== |