NCR Counterpoint Setup Checklist

Tick items as you complete them. Progress is saved for this browser tab and survives a refresh; it is not shared with other people or saved on the server.

For the Counterpoint installer and network administrator.

Licensing and API server

• Send CMS Max the merchant's company name and Counterpoint system serial number so we can arrange NCR approval for the developer key: developer API key request. NCR may request these merchant details by email.
• Separately request the merchant's API registration option through the reseller API option form, then install the updated registration.ini supplied by NCR.
• Install/start the Counterpoint API service and add/enable the correct company/database in API Management.
• Place the XML key supplied by CMS Max in the API service's APIKeys folder, normally C:\Program Files (x86)\NCR\Counterpoint API\APIKeys. Do not edit it. Restart/reload the service as needed and confirm it recognises the key. CMS Max keeps the matching TXT key.

The XML key and the API option in registration.ini are separate requirements; neither replaces the other.

Integration user and permissions

• Create a dedicated Counterpoint user for CMS Max with a strong password.
• Create and assign an API role for that user in the target company. Creating the user alone does not grant API access.
• Permit these GET requests:
  • /Items and /ItemCategories
  • /Inventory/Locations and /Inventory/{LocId}
  • /Items/{LocId} and /Item/{ItemNo}/Inventory/{LocId} when using location-specific pricing
  • /Item/{ItemNo}/Images and /Item/Images/{Filename} when syncing images or lookup files
• Confirm the password-expiry policy and how renewals will be handled. For automatic rotation, separately arrange and test permission for the account to change its own password. Read-only catalogue access does not prove this permission works.

Full administrator access is not required for the catalogue GET requests. Order/ticket write permissions are not needed for catalogue syncing.

External access

• Allow TCP 52000 through Windows Firewall on the server's active network profile, including Domain if applicable.
• Configure firewall/router port forwarding from the public address and external port to the Counterpoint server's private IP on TCP 52000.
• Restrict access to the CMS Max production outbound IP list, covering web and queue workers; include our development IP if requested. CMS Max will supply the current list.
• Provide an HTTPS endpoint, normally https://<public-host>:52000, with a trusted certificate matching that hostname. Tell us if it uses a self-signed certificate so we can agree a temporary exception. Opening port 443 is unnecessary if the service uses 52000.

Send back to CMS Max

• API endpoint URL including the port, not the API Management login-page URL.
• Company alias configured in API Management, which may differ from the SQL database name.
• Counterpoint username and password, shared securely. The API authenticates as CompanyAlias.Username; send the alias and username separately.
• Confirm licensing, XML installation, endpoint permissions and external access are complete. We will test from our application and queue environment, not just from inside the shop network.

Inventory locations can be discovered through the API. Please identify which locations should count towards online stock; we do not need their IDs before the first connection.

If images or readable profile/attribute labels are needed

• Ensure the API service can read the company's item-image directory and that new images continue reaching it.
• If codes need descriptions, arrange regularly updated tab-delimited ATTRCODES.txt and PROFCODES.txt files in the API-accessible image directory. Include code, description and validity flags for attribute slots 1–6 or profile slots 1–5. These exports supplement the API; they are not required for basic connectivity.

References

• NCR licensing: XML/TXT keys and the separate registration option
• NCR API Management: companies, users and roles