Network SDK questions
- Where do I get the Network SDK?
- Which versions of Windows are compatible with the Network SDK?
- How long does it take to integrate the Network SDK?
- How do I integrate the Network SDK?
- Where can I get help with integration questions?
- How do I QA my integration?
- Which installer platforms are supported?
- Which installer platform should I use?
- What if my installer platform isn’t supported?
- Can I use the C++ SDK with an unsupported installer platform?
- Does the Network SDK get installed when my installer runs?
- What information does the network client send to OpenCandy?
Q: Where do I get the Network SDK?
A: You can download the Network SDK from our developer sign-up page.
Q: Which versions of Windows are compatible with the Network SDK?
A: The Network SDK supports:
- Windows XP (32-bit, 64-bit) up to SP3
- Windows Vista (32-bit, 64-bit) up to SP2
- Windows 7 (32-bit, 64-bit) up to SP1
Availability of recommendations powered by OpenCandy varies by platform.
Q: How long does it take to integrate the Network SDK?
A: Integrations for typical installers using NSIS or Inno Setup can be completed in under 30 minutes. Integration with complex scripts may take longer. The length of time required to integrate the C++ SDK varies greatly depending upon the design of your installer code. Products using the C++ SDK are generally more prone to integration errors due to inconsistency in the design of the host product.
Q: How do I integrate the Network SDK?
A: For most platforms, integrating the Network SDK is quick and easy, and can be done in under half an hour by copying and pasting code snippets from our integration guides. Each of our SDKs includes source code for a fully integrated sample installer that you can use as a reference or adapt in just minutes if you don’t already have your own installer. Follow these steps to integrate the Network SDK:
- Download the Network SDK from our developer sign-up page and install the right SDK for your installer platform.
- Open the SDK integration guide using the link in the OpenCandy programs folder on your Start menu.
- Follow the steps in the SDK integration guide to try the sample installer and complete your own integration.
You must complete the developer sign-up process before you can release an installer that shows recomendations powered by OpenCandy.
Learn more about the OpenCandy Network SDK, integration and sign-up process.
Q: Where can I get help with integration questions?
A: You can access developer FAQs and ask for integration support on our developer support site.
Q: How do I QA my integration?
A: Each Network SDK contains a checklist with instructions explaining how you should test your integration before submitting your installer to OpenCandy for testing. Always follow the self-test checklist before submitting any installer.
Q: Which installer platforms are supported?
A: We provide dedicated SDKs for the following platforms (contact us for others):
- NSIS
- Inno Setup
- Wise
- C++
Q: Which installer platform should I use?
A: If you don’t already have an installer, check out our comparison of prominent installer platforms before you decide which SDK to use. Both our Inno Setup and NSIS SDKs contain fully integrated sample installers with source code that you can adapt and use for your own product installer.
Q: What if my installer platform isn’t supported?
A: Please contact us for help.
Q: Can I use the C++ SDK with an unsupported installer platform?
A: You can, but we suggest doing this only when you can create a plug-in for the platform that is itself written in C++ and uses the OCApi class we provide as part of the C++ SDK. We do not recommend reverse-engineering the C++ SDK to build your own wrapper around our the client DLL export procedures because these can change between SDK releases and there are various non-obvious integration requirements. Before you begin such work we recommend that you contact us for help.
Q: Does the Network SDK get installed when my installer runs?
A: No, the OpenCandy network client is extracted temporarily during your installation process to support recommendations powered by OpenCandy and cleans itself up automatically after any accepted offers are installed or cancelled.
Q: What information does the network client send to OpenCandy?
A: You can find detailed information on our Privacy Matters page.
If your question wasn’t answered here or you have suggestions on how we can do things even better, please let us know.
