API reference fields definition

This table shows the fields definitions that you need when you create new API references or modify saved API settings. You use the MI Name configured in the Partner Admin tool. This API name is used to connect to the M3 API server.

For more information, see the topic "Setting up API/MI application properties for MapGen" in the M3 Core Installation Guide.


Field	Description
Name	Name of the API reference. You use this value in the `APIMapper.mi.name` property in the EC Configuration Page.
Host	Name of the server where M3 BE Server runs.
Port	M3 BE Server port number to connect to M3 Interface (MI) programs. The M3 property file `boot.batchdispatcher.port` Default port number for M3 Java is `26800`. For M3 RPG, the port number is defined during the FPW (Floating Protocol Wrapper) setup. For more information on FPW, see the FPW documentation on the net. contains the port number to use. You can view this property file in M3 server view.
Encoding	Select the character encoding that this API connection will use to communicate with M3. You add new encoding in Manage > Advanced > Character Encodings tab. Default encoding for M3 Java is `UCS-2 (UTF-16 with no BOM)`. Default encoding for M3 RPG is `Latin1`.
M3 user	An M3 user for the API communication. This M3 user will establish the environment (M3 database), company and division, and other information to be used for the API calls.
Password	The M3 user password.
Force proxy	Select this to specify the proxy connection to use. You might need to use a proxy connection because of firewalls and NATed networks settings.
contains the port number to use. You can view this property file in M3 Company	Specify a numeric value, maximum of three digits. This value overrides the M3 API Company value.
Division	If the Company field has a value, use this field to assign a name for the Division. Use this to override the M3 API Division value.
API Type	Use API Type in authentication where you only have two options: API Socket = Basic authentication API Socket SSL = SSL authentication
SSL Keystore	Use SSL Keystore on API Socket SSL types, where you need to select a keystore created from the Manage>Certificate Keystores... menu/widget.
Import Use	Select an M3 API from the list then click Use. A numeric value 1 across an M3 API indicates that it is in use. When in use, it enables importing of agreements. You can not import agreements on an M3 API that is not in use.