SBN-Search
APIEngine sends installation searches from the SBN GUI, SBN Anywhere and API consumers to SBN-Search, passing the identity of the user who searched. SBN-Search returns only the installations that user is authorized to see. For what SBN-Search is and how to install it, see SBN-Search.
How it fits together
APIEngine calls the SBN-Search API over HTTPS and authenticates with an API key. The user's dealer access is resolved by SBN-Search, so the same search returns different results for users of different dealers.
What you need
- A running SBN-Search server. See Installing and Uninstalling.
- Its address, normally
https://<server>:9095, or the port chosen during installation. In a farm, each node has its own address. - An API key with the Search capability.
Create an API key
- Sign in to the SBN-Search Dashboard and open the API Keys tab.
- Press +, name the key (for example "APIEngine"), tick Search, and choose the dealers: All dealers, or Only selected to limit APIEngine to specific dealers.
- Copy the key value. It is shown only once.
Details: API Keys.
Configure APIEngine
In APIEngine Settings, open the Search section:
- Enable sbn-search - set to Yes. When set to No, APIEngine performs no installation searches.
- Timeout (seconds) - how long APIEngine waits for SBN-Search (default 30).
- Endpoints - enter the SBN-Search address (for example
https://<host>:9095) and paste the API key into the token box beside it. For a farm, press + Add Endpoint and add one address and key per node; APIEngine tries them in order.
Save the settings.
Confirm it works
On the APIEngine server, press Test Connection in the same section. It must be run from a browser on the APIEngine server itself. A working setup reports the SBN-Search version, the number of searchable dealers, and "Token accepted". Then run an installation search from the SBN GUI.
If the test fails, see APIEngine cannot reach SBN-Search.