Difference between revisions of "QuickStart Integration Guide"

From Payment Processing Software Library
Jump to: navigation, search
(Overview)
 
(44 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}}
=Software Installation & Configuration=
+
=Overview=
Note: This is a more complex guide. We suggest that you complete the simpler [[Quick Start Integration Guide]], first.
+
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.
 +
<br>[[File:sampleDemo.jpg|550px|Sample Demo  Program In Action]]
  
==Installation Topology Overview==
+
=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]]<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]]'''
  
[[File:ClientServerInstall1.jpg|frame|center|Simple Client-Server Installation. Note, that both components will happily reside on the same machine, as well.<br>See details below.]]
+
=Ingegration Options=
 +
==Integration Languages==
 +
There are several integration options for Creditline:
 +
#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==
+
==Integration Styles==
#Log onto the Server in the topology above.
+
There are three major integration styles
#Download the latest version of CreditLine '''"Standard CreditLine Manager and Server Download"'''  from http://911software.com -> Downloads page.
+
#&rarr; (recommended) Integrator uses CreditLine supplied UI (UI Encapsulation). This is '''clcUI [[PCI Friendly API]] Option''
#Install the program into '''"C:\CLServer\911"''' directory (you will have a chance to specify the directory).
+
#Integrator provides their own UI
 
+
#Integrator uses Encrypted Text Import for manual batch processing
===Server Side Directory Description===
+
*c:
+
**CLServer  &rarr; ''Share as CLShare''
+
***911
+
****Bin
+
::::-CCV_SERVER.EXE  &rarr; "CreditLine Server"
+
::::-CCV_MANAGER.EXE &rarr; "CreditLine Manager"
+
::::-clcapiw.h &rarr; "API HEADER"
+
::::-clcapiw2.dll &rarr; "API DLL"
+
::::-clcCs.dll &rarr; ".NET Wrapper
+
::::-clcClient.ocx &rarr; "OCX Wrapper"
+
::::-clcUI.exe &rarr; Optional Quick PCI Friendly UI
+
::::-clcUI.ini &rarr; Customization for PCI Friendly UI
+
 
+
==Client Side Install==
+
#Log into Client in the topology above.
+
#Download the latest version of CreditLine '''"Client Only Regular Install"'''  from http://911software.com -> Downloads page.
+
#Install the program into '''"C:\CLClient\911"''' directory (you will have a chance to specify the directory).
+
 
+
===Client Side Directory Description===
+
*c:
+
**CLClient
+
***911
+
****API
+
::::-clcapiw.h &rarr; "API HEADER"
+
::::-clcapiw2.dll &rarr; "API DLL"
+
::::-clcCs.dll &rarr; ".NET Wrapper
+
::::-clcClient.ocx &rarr; "OCX Wrapper"
+
:::*BIN
+
::::-clcUI.exe &rarr; Optional Quick PCI Friendly UI
+
::::-clcUI.ini &rarr; Customization for PCI Friendly UI
+
 
+
==Setting up Client-Server Communication==
+
===Server Side===
+
#Log into Server
+
#Share the CLServer directory (containing 911 directory) on the server with full permissions (scroll down for a screenshot).
+
##Navigate to the installation drive
+
##Right click on '''CLServer''' directory
+
##Select '''Properties''' &rarr; '''Sharing''' &rarr; '''Advanced Sharing'''
+
##Check '''Share This Folder''', leave the '''Share name''' as CLShare
+
##Click '''Permissions'''  
+
##Select '''Everyone'''
+
##Click '''Allow''' across from '''Full Control'''
+
[[File:ServerShare.jpg|1000px|Creating the Server Share]]
+
 
+
===Client Side===
+
#Log into 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: <br>[[File:MapDrive.jpg|1000px]]
+
#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 '''c:\CLServer\911\BIN\CCV_SERVER.exe''' (CreditLine Server) and then '''c:\CLServer\911\BIN\CCV_MANAGER.exe''' (CreditLine Client). 
+
#Login with the default User Name and Password are on the 911 Software downloads page (admin/creditline1).
+
#Change the password, if prompted
+
#The software comes with a test account.
+
#Run a test card (4111 1111 1111 1111, with any valid exp date) for $1 by selecting Command->Sale from CreditLine Manager
+
[[File:CommandSale.jpg]]
+
 
+
==Client Side==
+
===Creating a Manager Shortcut===
+
#On the client, navigate to the server mapped Z: drive. 
+
#Enter Z:\911\BIN
+
#Hold Alt, while left-clicking on  CCV_Manager.exe (CREDITLINE CLIENT) and dragging it to the desktop.
+
#Release the mouse<br>[[File:RunningManagerfromServer.jpg]]
+
#Double click on the CreditLine Manager Shortcut to start the Manager.
+
#Login with the default User Name and Password are on the 911 Software downloads page (admin/creditline1).
+
#Change the password, if prompted
+
#The software comes with a test account.
+
#Run a test card (4111 1111 1111 1111, with any valid exp date) for $1 by selecting Command->Sale from CreditLine Manager
+
[[File:CommandSale.jpg]]
+
  
 
=Samples Installation and Configuration=
 
=Samples Installation and Configuration=
 
==Sample Repository==
 
==Sample Repository==
 
The sample directory is located here: [http://911software.com/files/samples CreditLine Integration Samples Repository]
 
The sample directory is located here: [http://911software.com/files/samples CreditLine Integration Samples Repository]
&rarr; Note: the following technologies are filed under the '''legacy''' directory: VB6, Java, C++, .Net
+
<br>&rarr; Note: the following technologies are filed under the '''legacy''' directory: VB6, Java, C++, .Net
  
 
+
==Sample Installation==
==Sample Configuration==
+
 
#Complete the installation steps above.  
 
#Complete the installation steps above.  
 
#Log into the Client
 
#Log into the Client
 
#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)
 
#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)
#If you copy any files from the sample to CreditLine Client installation path(C:\CLClient\911\api), do not overwrite any files.
+
#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.
#The compiled sample application is CSDriver.exe
+
#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. Make sure, to set the correct path to the server's 911 directory (e.g. Z:/911 in this case)
+
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