Difference between revisions of "QuickStart Integration Guide"

From Payment Processing Software Library
Jump to: navigation, search
(Created page with "{{CreditLine Header|Quick Start Networked Sample Integration Guide}} '''>>>> SORRY, THIS SECTION IS UNDER CONSTRUCTION!!! <<<<<'''<br> ''>>>> SORRY, THIS SECTION IS UNDER CONS...")
 
(→‎Overview)
 
(100 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{CreditLine Header|Quick Start Networked Sample Integration Guide}}
 
{{CreditLine Header|Quick Start Networked Sample Integration Guide}}
−
'''>>>> SORRY, THIS SECTION IS UNDER CONSTRUCTION!!! <<<<<'''<br>
+
=Overview=
−
''>>>> SORRY, THIS SECTION IS UNDER CONSTRUCTION!!! <<<<<''<br>
+
In this quickstart guide we will help you setup a Sample Demo executable that has the ability to test and troubleshoot CreditLine APIs.
−
>>>> SORRY, THIS SECTION IS UNDER CONSTRUCTION!!! <<<<<
+
&rarr; Below is a screenshot of extended VB demo in action.  There are also simplified demos for other languages.
 +
<br>[[File:sampleDemo.jpg|550px|Sample Demo  Program In Action]]
  
−
=Software Installation & Configuration=
+
=CreditLine Client and Server Installation=
−
Note: This is a more complex guide. We suggest that you complete the simpler [[Quick Start Integration Guide]], first.
+
The following samples rely on a known installation structure. If you already installed the software, you might want to uninstall it and follow one of the guides below, to ensure smooth integration experience.
 +
If client and server reside on '''separate networked machines''', please follow '''[[CreditLine Networked Client-Server Installation]]<br>[[File:ClientServerInstall1.jpg|Simple Client-Server Installation]]'''
 +
<br>
 +
<hr>
 +
If client and server  reside on the '''same machine''', please follow '''[[CreditLine Local Client-Server Installation]]'''
  
−
==Basic Client-Server Installation Topology==
+
=Ingegration Options=
−
{| style=" border: 1px dashed red; width="400px"
+
==Integration Languages==
−
|- style="vertical-align: top;"
+
There are several integration options for Creditline:
−
|[[File:BasicTopology.jpg|frame|Simple Client-Server Installation. Note, that both components will happily reside on the same machine, as well ]]
+
#DLL for C#, C++, et
−
|-
+
#Java Wrapper for Java
−
|
+
#OCX for Visual Basic, dotNet, etc
−
|}
+
#Encrypted Text Import for manual batch processing.
−
==Server Side Install==
+
−
#Log in Machine A(CreditLine Server) in the topology above.
+
−
#Download the latest version of CreditLine '''"Standard CreditLine Manager and Server Download"'''  from http://911software.com -> Downloads page.
+
−
#'''Make sure''' to change the install destination directory from '''"C:\911"''' to '''"C:\CLServer\911"'''. You can use any other drive, but this example sake, please preserve the directory structure.
+
−
#Run the downloaded setup and follow the instructions to complete the installation of the software. Make sure to select the correct directory, as specified above.
+
  
−
==Client Side Install==
+
==Integration Styles==
−
#Log in to Machine B(CreditLine Client) in the topology above.
+
There are three major integration styles
−
#Download te latest version of CreditLine '''"Client Only Regular Install"'''  from http://911software.com -> Downloads page.
+
#&rarr; (recommended) Integrator uses CreditLine supplied UI (UI Encapsulation).  This is  '''clcUI [[PCI Friendly API]] Option''
−
#Run the downloaded setup and follow the instructions to complete the installation of the software. Accept default installation directory for simplicity of example.
+
#Integrator provides their own UI
−
 
+
#Integrator uses Encrypted Text Import for manual batch processing
−
==Setting up Client-Server Communication==
+
−
===Server Side====
+
−
#Log in to Machine B(CreditLine Server) in the topology above.
+
−
#Share the CLServer directory (containing 911 directory) on the server (let's call it CLShare)
+
−
##Navigate to the installation drive
+
−
##Right click on CLServer directory
+
−
##Select "Share".  Name the share "CLShare"
+
−
===Client Side===
+
−
#Log in to Machine A(CreditLine Client) in the topology above.
+
−
#Navigate to the Server from the Network interface in Windows.
+
−
#Map the \\Server\CLShare to a new drive, let's call it Z:
+
−
#In the sample programming examples below, you will be setting your data directory to '''"Z:/911/DATA"''' and messages directory to '''"Z:/911/MESSAGES"'''
+
−
 
+
−
=Testing the Installation=
+
−
==Server Side==
+
−
#Run CreditLine Server and then CreditLine Client.  The default User Name and Password are on the 911 Software downloads page.
+
−
==Client Side==
+
−
#On the client, navigate to the server mapped Z: drive. 
+
−
#Enter 911 directory
+
−
#Right click CCV_Manager.exe (CREDITLINE CLIENT) drag to the desktop and select "Create Shortcut"
+
−
#Place the shortcut on the desktop
+
−
#Right Click the new Shortcut and select Properties
+
−
#Enter '''Z:\911''' in the "Start In" field
+
−
#Click OK and run the new Shortcut.
+
  
 
=Samples Installation and Configuration=
 
=Samples Installation and Configuration=
−
==Prerequisites==
+
==Sample Repository==
−
Microsoft .NET Framework 2.0 or higher
+
The sample directory is located here: [http://911software.com/files/samples CreditLine Integration Samples Repository]
 +
<br>&rarr; Note: the following technologies are filed under the '''legacy''' directory: VB6, Java, C++, .Net
  
−
==Sample Configuration==
+
==Sample Installation==
 
#Complete the installation steps above.  
 
#Complete the installation steps above.  
−
#If testing in a multi machine environment, log into Machine B(CreditLine Client)
+
#Log into the Client
−
#Download the sample(CS:C Sharp, VB.Net) from [http://911software.com/files/samples Samples Repository]
+
#Download the sample from relevant folder [http://911software.com/files/samples CreditLine Integration Samples Repository], corresponding to the technology that you are using (e.g. C_Sharp for C# or legacyVB6JavaCppDotNet/VB6 for VB6)
−
#Copy “clcCom.dll”, “CSDriver.exe” files to CreditLine Client installation path(C:\911\api).<br>&rarr;Note: Please do NOT overwrite the existing files(ClcCom is the new com library, it can be used in C#, VB.Net).
+
#If you copy any files from the sample to CreditLine Client installation path(C:\CLClient\911\api), do not overwrite any files on the client, as what you installed prior will be usually newer.
−
#Copy folder “C:\911\BIN” and “C:\911\Data” from server Machine A to client Machine B’s installation path(C:\911).
+
#Please, read and follow the important steps, outlined in the '''README''' file inside the sample directory.
  
 
=Running The Sample=
 
=Running The Sample=
−
#Double chick CSDriver.exe to run the Sample.
+
Every Sample Directory has:
 +
<br>a)Already compiled executable
 +
<br>b)Source code
 +
<br>c)Read me file
 +
<hr>
 +
<br>'''To begin:'''
 +
#Make sure to read and follow directions in the README file, first
 +
#When  you run the sample EXE, make sure, to set the correct path to the server's 911 directory (e.g. c:\CLServer\911\bin or Z:/911, if the server is on another machine and Z is the mapped drive)
 
[[File:SampleRun.jpg|none|600px|Running Sample Screen]]
 
[[File:SampleRun.jpg|none|600px|Running Sample Screen]]
 +
#Take a look at the clcapiw.h in c:\CLServer\911\BIN folder for the full list of available functions
 +
#Source code contains all the common API sequences
 +
#The dialogs for different languages may vary.
 +
#The difference between regular calls and CLCUI calls (prefixed with clc), is that clcUI has its own customizable interface to help you avoid handling secure data. For more info see [[PCI Friendly API]]
 +
 +
 +
=Integration Tutorial=
 +
  &rarr; Please, see [[CreditLine Integration Tutorial]]
 +
 +
=List of API Calls=
 +
Please see '''<font color="#008000">c:\CLServer\911\BIN\CLCAPIW.h</font>'''
 +
  '''NOTE: ''' OCX/COM/ATL objects simply wrap the standard API DLL, removing "clc" prefix from functions.
  
−
=Programming the Samples=
 
−
#Add the reference to the ClcCom library.
 
−
##In "vs.net 2005 IDE", Select Project->Add Reference.
 
−
##In the popup window, select Browse and then browse to the directory to select the ClcCom.dll.
 
−
#After that, you can follow the sample to program.
 
−
&rarr; Note: If you have more than one Client, please call the api "void setClientName(string ClientName)" to set a different name for each Client before processing any transactions.
 
 
=Troubleshooting=
 
=Troubleshooting=
 
#When running the sample application, if you encounter the error “side-by-side…”. Please try to install “vcredist_x86.exe” on your environment.
 
#When running the sample application, if you encounter the error “side-by-side…”. Please try to install “vcredist_x86.exe” on your environment.
 
#For Win7 User, no matter the OS is Win7-32bit or Win7-64bit, we suggest you to enable ‘Is64BitPlatform=YES’ in ClcCs.ini which can be found in C:\911\api.
 
#For Win7 User, no matter the OS is Win7-32bit or Win7-64bit, we suggest you to enable ‘Is64BitPlatform=YES’ in ClcCs.ini which can be found in C:\911\api.
 +
 +
=Documentation=
 +
&rarr; After you have a working sample integration, we suggest that you peruse the [[CreditLine Integration Tutorial|CreditLine Integration Guide]]
  
 
[[Category:CreditLine Integration|Integration Guides]]
 
[[Category:CreditLine Integration|Integration Guides]]

Latest revision as of 02:52, 30 August 2016

This article is part of the
Payment Processing Software Library

Categories

Get it...

Credit Card Software
Download

Install it...

Installation
Upgrade & Migration

Connect to it...

→ Point Of Sale Integration

Set it up...

→ Quick Start Guide
→ Setup
→ Processor Setup

Licensing

Learn to use it...

→ Manual & User Guide
→ Knowledge Base
→ Frequently Asked Questions
Compliance Guide
Merchant Account Rates
User Interface Guides

Fix it...

→ Errors & Troubleshooting
→ Knowledge Base
Corrupted Install Repair

Get Help...

Contact
→ Processor Support Contacts

More Info ...

Glossary
Articles

See also...

911 Software
Help

CreditLine Payment Processing Software Quick Start Networked Sample Integration Guide. This site can also be reached at http://docs.911software.com

→ Looking for better rates?   Get a Free Credit Card Processing Cost Comparison!

Overview

In this quickstart guide we will help you setup a Sample Demo executable that has the ability to test and troubleshoot CreditLine APIs. 

→ Below is a screenshot of extended VB demo in action.  There are also simplified demos for other languages.


Sample Demo Program In Action

CreditLine Client and Server Installation

The following samples rely on a known installation structure. If you already installed the software, you might want to uninstall it and follow one of the guides below, to ensure smooth integration experience. 

If client and server reside on separate networked machines, please follow CreditLine Networked Client-Server Installation
Simple Client-Server Installation



If client and server  reside on the same machine, please follow CreditLine Local Client-Server Installation

Ingegration Options

Integration Languages

There are several integration options for Creditline:

  1. DLL for C#, C++, et
  2. Java Wrapper for Java
  3. OCX for Visual Basic, dotNet, etc
  4. Encrypted Text Import for manual batch processing.

Integration Styles

There are three major integration styles

  1. → (recommended) Integrator uses CreditLine supplied UI (UI Encapsulation). This is 'clcUI PCI Friendly API Option
  2. Integrator provides their own UI
  3. Integrator uses Encrypted Text Import for manual batch processing

Samples Installation and Configuration

Sample Repository

The sample directory is located here: CreditLine Integration Samples Repository
→ Note: the following technologies are filed under the legacy directory: VB6, Java, C++, .Net

Sample Installation

  1. Complete the installation steps above.
  2. Log into the Client
  3. Download the sample from relevant folder CreditLine Integration Samples Repository, corresponding to the technology that you are using (e.g. C_Sharp for C# or legacyVB6JavaCppDotNet/VB6 for VB6)
  4. If you copy any files from the sample to CreditLine Client installation path(C:\CLClient\911\api), do not overwrite any files on the client, as what you installed prior will be usually newer.
  5. Please, read and follow the important steps, outlined in the README file inside the sample directory.

Running The Sample

Every Sample Directory has:
a)Already compiled executable
b)Source code
c)Read me file


To begin:

  1. Make sure to read and follow directions in the README file, first
  2. When you run the sample EXE, make sure, to set the correct path to the server's 911 directory (e.g. c:\CLServer\911\bin or Z:/911, if the server is on another machine and Z is the mapped drive)
Running Sample Screen
  1. Take a look at the clcapiw.h in c:\CLServer\911\BIN folder for the full list of available functions
  2. Source code contains all the common API sequences
  3. The dialogs for different languages may vary.
  4. The difference between regular calls and CLCUI calls (prefixed with clc), is that clcUI has its own customizable interface to help you avoid handling secure data. For more info see PCI Friendly API


Integration Tutorial

 → Please, see CreditLine Integration Tutorial

List of API Calls

Please see c:\CLServer\911\BIN\CLCAPIW.h 

 NOTE:  OCX/COM/ATL objects simply wrap the standard API DLL, removing "clc" prefix from functions.

Troubleshooting

  1. When running the sample application, if you encounter the error “side-by-side…”. Please try to install “vcredist_x86.exe” on your environment.
  2. For Win7 User, no matter the OS is Win7-32bit or Win7-64bit, we suggest you to enable ‘Is64BitPlatform=YES’ in ClcCs.ini which can be found in C:\911\api.

Documentation

→ After you have a working sample integration, we suggest that you peruse the CreditLine Integration Guide
Retrieved from "http://docs.911software.com/credit_card_processing_software/index.php?title=QuickStart_Integration_Guide&oldid=6404"