API Code Samples - Revision history

Dina: /* Python Sample 2 */

2020-11-02T11:36:02Z

Python Sample 2

← Older revision		Revision as of 11:36, 2 November 2020
Line 905:		Line 905:

	<pre>		<pre>


	import clr		import clr
	from System import String, Char, Int32		from System import String, Char, Int32
Line 945:		Line 943:
	MSP.Terminate()		MSP.Terminate()
	print(f"Database initialized: {MSP.instance().initialized_}")		print(f"Database initialized: {MSP.instance().initialized_}")




	</pre>		</pre>

Dina: /* Python Sample */

2020-11-02T09:41:15Z

Python Sample

@@ Line 775: / Line 775: @@
-====Python Sample====
+====Python Sample 1====
 For all field description see the [[API Reference Manual]].
@@ Line 893: / Line 893: @@
          db.TerminateDbEngDll()
 </pre>

Dina at 07:11, 8 July 2020

2020-07-08T07:11:56Z

Show changes

Dina at 18:37, 21 March 2020

2020-03-21T18:37:21Z

← Older revision		Revision as of 18:37, 21 March 2020
Line 1,080:		Line 1,080:
	\|-		\|-
	\|<ResultCodes><br><ResultMessage>		\|<ResultCodes><br><ResultMessage>
	\|In case of a failure, this will contain the error code and description. You can find more information about error codes [[~~Commit~~ API Reference Manual#Error Codes Description\|here]].		\|In case of a failure, this will contain the error code and description. You can find more information about error codes [[API Reference Manual#Error Codes Description\|here]].
	\|}		\|}

Dina at 18:19, 21 March 2020

2020-03-21T18:19:29Z

← Older revision		Revision as of 18:19, 21 March 2020
Line 309:		Line 309:
	The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.		The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

	Make sure to read [[~~Commit~~ API Developers Guide\|CommitCRM API Developers Guide]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.		Make sure to read [[API Developers Guide\|CommitCRM API Developers Guide]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

	To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\CommitCRM\LastVer (and to the same files it already points to).		To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\CommitCRM\LastVer (and to the same files it already points to).
Line 902:		Line 902:
	Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.		Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

	Also please read [[~~Commit_API_Developers_Guide~~#Using_CommitCRM_API\|CommitCRM API Reference Manual]] before going through the samples, as it provides an overview of the CommitCRM API work-flow and how it should be used.		Also please read [[API_Developers_Guide#Using_CommitCRM_API\|CommitCRM API Reference Manual]] before going through the samples, as it provides an overview of the CommitCRM API work-flow and how it should be used.

	Notes on API by Email Activation:		Notes on API by Email Activation:
Line 1,084:		Line 1,084:

	== See Also ==		== See Also ==
	*[[~~Commit~~ API Developers Guide\|CommitCRM API Developers Guide]]		*[[API Developers Guide\|CommitCRM API Developers Guide]]
	*[[API Reference Manual]]		*[[API Reference Manual]]
	[[Category:User Manuals]]		[[Category:User Manuals]]
	[[Category:Integration]]		[[Category:Integration]]

Dina: /* Python Sample */

2015-10-11T11:50:15Z

Python Sample

← Older revision		Revision as of 11:50, 11 October 2015
Line 780:		Line 780:
	''Contributed by: Joe Kogut''		''Contributed by: Joe Kogut''

	Note: The example was tested on Python 3.5, but will work with Python 3.7 with minor modifications.		Note: The example was tested on Python 3.5, but will work with Python 2.7 with minor modifications.

	<pre>		<pre>

Dina: /* Python Sample */

2015-10-11T07:37:35Z

Python Sample

← Older revision		Revision as of 07:37, 11 October 2015
Line 777:		Line 777:
	====Python Sample====		====Python Sample====
	For all field description see the [[API Reference Manual]].		For all field description see the [[API Reference Manual]].

			''Contributed by: Joe Kogut''

			Note: The example was tested on Python 3.5, but will work with Python 3.7 with minor modifications.

	<pre>		<pre>
	import os		import os
	from ctypes import *		from ctypes import *

Dina: /* Data Update API Samples */

2015-10-11T07:30:10Z

Data Update API Samples

@@ Line 773: / Line 773: @@
    readln;
   end.
 ===XML samples===

Robert: /* XML samples */

2013-08-29T13:45:20Z

XML samples

← Older revision		Revision as of 13:45, 29 August 2013
Line 780:		Line 780:
	Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.		Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

	Also please read [[Commit_API_Developers_Guide#~~Using_Commit_API~~\|CommitCRM API Reference Manual]] before going through the samples, as it provides an overview of the CommitCRM API work-flow and how it should be used.		Also please read [[Commit_API_Developers_Guide#Using_CommitCRM_API\|CommitCRM API Reference Manual]] before going through the samples, as it provides an overview of the CommitCRM API work-flow and how it should be used.

	Notes on API by Email Activation:		Notes on API by Email Activation:

Robert at 13:44, 29 August 2013

2013-08-29T13:44:12Z

← Older revision		Revision as of 13:44, 29 August 2013
Line 309:		Line 309:
	The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.		The following code samples demonstrate how to add and update a record in CommitCRM from VBA, C++ or Delphi programs.

	Make sure to read [[Commit API Developers Guide]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.		Make sure to read [[Commit API Developers Guide\|CommitCRM API Developers Guide]] before going through the samples, as it provides an overview of the Commit API work-flow and how it should be used.

	To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\~~Commit~~\LastVer (and to the same files it already points to).		To test samples, it is recommended that you download a trial version of CommitCRM from our web site and install it on a new computer that is not running CommitCRM. Then, modify the paths in the source code to point to folder <testcomputer>\CommitCRM\LastVer (and to the same files it already points to).

	When developing your programs please make sure you work under the <testcomputer>\~~Commit~~\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.		When developing your programs please make sure you work under the <testcomputer>\CommitCRM\ThirdParty\UserDev folder (or at least call the dlls in this location). Do not copy the dll’s to any other location.

	These samples create a connection to CommitCRM's database, add a new Account record into		These samples create a connection to CommitCRM's database, add a new Account record into
Line 477:		Line 477:
	// Specify a meaningful value.		// Specify a meaningful value.
	"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is		"C:\\Demo\\DB\\", //Path to the database folder where CommitCRM the server is
	// installed <server>\~~Commit~~\Db		// installed <server>\CommitCRM\Db
	&Status); //Returned connection status		&Status); //Returned connection status

Line 597:		Line 597:
	// will be used for all		// will be used for all
	// functions of the package. Specify a meaningful value.		// functions of the package. Specify a meaningful value.
	xDbPath : PChar; // Path to the DB folder under where ~~Commit~~ server is		xDbPath : PChar; // Path to the DB folder under where CommitCRM server is
	// installed <server>\~~Commit~~\Db		// installed <server>\CommitCRM\Db

	var xvStatus : integer // Returned connection status		var xvStatus : integer // Returned connection status
Line 675:		Line 675:
	CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used		CmtInitDbEngDll(C_AppName, // Your application name. Once selected this string will be used
	// for all functions of the package. Specify a meaningful value.		// for all functions of the package. Specify a meaningful value.
	'C:\DemoDelphi\db\', // Path to the DB folder under where ~~Commit~~ server is		'C:\DemoDelphi\db\', // Path to the DB folder under where CommitCRM server is
	// installed <server>\~~Commit~~\Db		// installed <server>\CommitCRM\Db
	Status // Returned connection status		Status // Returned connection status
	);		);
Line 776:		Line 776:
	===XML samples===		===XML samples===

	Following are samples for adding a new Ticket and a new Charge to the ~~Commit~~ database using XML formatted messages.		Following are samples for adding a new Ticket and a new Charge to the CommitCRM database using XML formatted messages.

	Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.		Make sure to go over the [[Email Connector]] setup guide, and perform the XML API setup steps prior to testing the XML API.

	Also please read [[Commit_API_Developers_Guide#Using_Commit_API\|~~Commit~~ API Reference Manual]] before going through the samples, as it provides an overview of the ~~Commit~~ API work-flow and how it should be used.		Also please read [[Commit_API_Developers_Guide#Using_Commit_API\|CommitCRM API Reference Manual]] before going through the samples, as it provides an overview of the CommitCRM API work-flow and how it should be used.

	Notes on API by Email Activation:		Notes on API by Email Activation:
Line 788:		Line 788:
	*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[API_Code_Samples#General_XML_Tokens\|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.		*Using a Password - If you wish to use a verification password for the XML transactions, define the password using the ServerConfig.exe utility. To do so, go to the XML tab, enable the API by Email option and set a password (as specified in the XML - see [[API_Code_Samples#General_XML_Tokens\|General XML Tokens]]). Make sure to set the same Password in ServerConfig and in the XML email itself.

	You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector\|~~Commit~~ Email Connector]] Setup guide.		You can read more about the ServerConfig and how to setup the API by Email configuration in the [[Email Connector\|CommitCRM Email Connector]] Setup guide.


Line 962:		Line 962:

	== See Also ==		== See Also ==
	*[[Commit API Developers Guide]]		*[[Commit API Developers Guide\|CommitCRM API Developers Guide]]
	*[[API Reference Manual]]		*[[API Reference Manual]]
	[[Category:User Manuals]]		[[Category:User Manuals]]
	[[Category:Integration]]		[[Category:Integration]]