Command-line/Manual Integration

Prerequisites
Complete review of the Getting Started section.
Review of the Digging Deeper section.
A program registered to the ISB (for the purposes of this integration).

Manual Integration Steps: (a video tutorial is also available)

  1. In Web Manager on the Programs page “View” your Program. In the Overview section, copy the .NET command line and paste it into a text editor, like Notepad.

    You’ll need this for the integration, as outlined below.

  2. Open Visual Studio and either create a new Project or open an existing Project/Solution.
  3. Add a Reference to the LinxterSDK.dll assembly, usually located in “C:\Program Files\Linxter Software Development Kit\bin\”.
  4. You will now use the command-line tool to setup the API's encrypted database:
    1. Open a console window (e.g. run cmd.exe).
    2. Navigate to your project’s directory.

    3. Execute the command-line you previously pasted into your text editor. Note, the /i, or install arguement is follwed by these arguments: c, d, and p, whereas c=Company ID, d=Developer ID, and p=Program ID

      Example: LinxterTool.exe /i /c 00000000-0000-0000-0000-000000000000 /d 00000000-0000-0000-0000-000000000000 /p 00000000-0000-0000-0000-000000000000

  5. Next, in your Visual Studio project, click the “Refresh” icon, and then the “Show All Files”.
  6. Right click the “LinxterSDKDB” file and select “Include In Project”.

  7. Right click the “LinxterSDKDB” file again and select “Properties”, and change the “Copy to Output Directory” to “Copy if newer”
  8. Now you’re ready to start writing code. Depending on where in your code you want Linxter to reside, add these if using C#:

    using Linxter.SDK;
using Linxter.Common.Entities;
using Linxter.SDK.EventArgs;

    or these if using Visual Basic:

    Imports Linxter.SDK
Imports Linxter.Common.Entities
Imports Linxter.SDK.EventArgs

You are done! Linxter has been integrated into your program. You can now begin to use the methods, properties and events of the Linxter API.

Note: In your code, when you call the CreateMessage() or CreateMessages() method, you will need to include your program's ActivityID which was generated when you registered your program to the ISB.

IMPORTANT: Your Company, Developer and Activity IDs should be kept secret. You should never include them in any communication. You should never e-mail these IDs to anyone. It is important to keep these confidential to protect your account.