
Before you start
All Bluefin partners fall into two categories: Single Account Partners and Internet Service Vertical (ISV) Partners. Non-ISV partners use Bluefin Web Client API for single account -- their own. ISV partners serve other parties with Bluefin Account.
Prerequisites
In order to start using Bluefin Web Client API
Download latest SDK archive file for .NET target framework of your choice. SDK files adhere to the following naming convention:
Bluefin-APIversion-netVersion.zip|dll|xml|...
where
APIversion is the Bluefin Web Client API version. The latest version is 3.8.
netVersion is .NET target framework. Bluefin supports .NET 2.0, 3.0, 3.5, 4.0 and 4.5.
For example, Bluefin-1.3-net4.0.zip is the latest SDK distribution for .NET target framework 4.0.
- Contact Bluefin representative to setup either your or your clients acccess to our test environment. You will be provided with one or more values for accountID, accessKey and baseURL. See Application Configuration section below.
SDK Content
- Bluefin-APIversion-netVersion.dll -.NET Bluefin Web Client API
- Bluefin-APIversion-netVersion.xml - Intellisence Help Support File
Bluefin-APIversion-netVersion.Help.zip - Web Client API Help Files. The archive includes
- Html Help 1 file (Bluefin DotNET API Help.chm)
- Web Site Help Files
- Visual Studio (VS) Integrated Help Files (Bluefin DotNET API Help.msha and Bluefin DotNET API Help..mshc)
- Bluefin-APIversion-netVersion.Walkthrough.zip - Microsoft Visual Studio Solution you can use to build numereous Web Client API tests for .NET 2.0, 3.0, 3.5 and 4.0. See Walkthrough topic for more details.
Installation Instructions
- Unzip SDK file to known location.
- Copy .NET API Library Bluefin-APIversion-netVersion.dll to your solution's library folder. For example, Solution\Lib. Optionally copy there Bluefin-APIversion-netVersion.xml. It will enable Visual Studio Intellisence help support for Bluefin .NET API.
- Add the reference to Bluefin-APIversion-netVersion.dll to your Visual Studio project(s).
Unzip Bluefin-APIversion-netVersion.Help.zip file to known location. For example, Solution\Lib\Help. Double click Bluefin DotNET API Help.chm file and Windows should bring Html Help 1 GUI with loaded Help file. If you prefer to use your favorite browser to view Help, open the file Solution\Lib\Help\index.html.
You also can add Bluefin Help to integrated Visual Studio 2010 Help System
- Run as Administrator the script Solution\Lib\Help\Install_Bluefin DotNET API Help.bat. It will bring Help Library Manager's "Install Content from Disk" dialog.
- Click "Add" for Bluefin Web Client API Documentation. It will enable "Update" button.
- Click "Update" to integrate Bluefin Help to your Visual Studio Help. After successful integration you should have F1 support on Bluefin .NET API.
Or you can do it manually
- Bring Visual Studio Help Library Manager (Main Menu->Help->Manage Help Settings)
- Click "Install content from disk" and browse to Bluefin DotNET API Help.msha file.
- Click "Next" to integrate Bluefin Help to your Visual Studio Help. After successful integration you should have F1 support on Bluefin .NET API.
Application Configuration
Add accountID, accessKey and baseURL to your application configuration file (app.config, web.config etc.) as follow:
If your code will deal with multiple Bluefin Accounts, add the following fragment o your application configuration file (app.config, web.config etc.)