Updates

Notice: Discontinuation of TLS 1.0

On March 26th, 2016, NeonCRM’s API will be will be removing protocol support for TLS v1.0. This upgrade may affect your ability to connect to NeonCRM’s API.

Any API integrations you have built will need to be compatible with TLS versions 1.1 or 1.2.

These changes are technical and we advise you to consult with your technology teams. We have provided a table (below) that has information on which platforms are compatible with versions of TLS.

Platform or Library TLS 1.1 or Higher Compatibility Notes
Java Compatible with the most recent, stable version, regardless of operating system
Java 8 (1.8) and higher Compatible by default
Java 7 (1.7) Enable TLS 1.1 and TLS 1.2 using the https.protocols Java system property for HttpsURLConnection. To enable TLS 1.1 and TLS 1.2 on non-HttpsURLConnection connections, set the enabled protocols on the created SSLSocket and SSLEngine instances within the application source code.
Java 6 (1.6) and below Not compatible with TLS 1.1 or higher encryption
.NET Compatible with the most recent, stable version when run in an operating system that supports TLS 1.1 or TLS 1.2

.NET 4.6 and higher

Compatible by default
.NET 4.5 to 4.5.2
  • .NET 4.5, 4.5.1, and 4.5.2 do not enable TLS 1.1 and TLS 1.2 by default. Two options exist to enable these, as described below.
  • .NET applications may directly enable TLS 1.1 and TLS 1.2 in their software code by setting System.Net.ServicePointManager.SecurityProtocol to enable SecurityProtocolType.Tls12 and SecurityProtocolType.Tls11. The following C# code is an example:
  • System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
  • Alternatively, it may be possible to enable TLS 1.2 by default without modifying the source code by setting the SchUseStrongCrypto DWORD value in the following two registry keys to 1, creating them if they don’t exist: “HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v4.0.30319” and “HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319”. Although the version number in those registry keys is 4.0.30319, the .NET 4.5, 4.5.1, and 4.5.2 frameworks also use these values. Those registry keys, however, will enable TLS 1.2 by default in all installed .NET 4.0, 4.5, 4.5.1, and 4.5.2 applications on that system. It is thus advisable to test this change before deploying it to your production servers. This is also available as a registry import file. These registry values, however, will not affect .NET applications that set the System.Net.ServicePointManager.SecurityProtocol value.
.NET 4.0

.NET 4.0 does not enable TLS 1.2 by default. To enable TLS 1.2 by default, it is possible to set the SchUseStrongCrypto DWORD value in the following two registry keys to 1, creating them if they don’t exist: “HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v4.0.30319” and “HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319”. Those registry keys, however, will enable TLS 1.2 by default in all installed .NET 4.0, 4.5, 4.5.1, and 4.5.2 applications on that system. We recommend testing this change before deploying it to your production servers. This is also available as a registry import file. These registry values, however, will not affect .NET applications that set the System.Net.ServicePointManager.SecurityProtocol value.

.NET 3.5 and below Not compatible with TLS 1.1 or higher encryption
Python Compatible with the most recent, stable version when run in an operating system that supports TLS 1.1 or TLS 1.2

Python 2.7.9 and higher

Compatible by default

Python 2.7.8 and below

Not compatible with TLS 1.1 or higher encryption

Ruby

Compatible with the most recent, stable version when linked to OpenSSL 1.0.1 or higher

Ruby 2.0.0

TLS 1.2 is enabled by default when used with OpenSSL 1.0.1 or higher. Using the :TLSv1_2 (preferred) or :TLSv1_1 symbols with an SSLContext’s ssl_version helps ensure that TLS 1.0 or earlier is disabled.

Ruby 1.9.3 and below

The :TLSv1_2 symbol does not exist in 1.9.3 and below, but it is possible to patch Ruby to add that symbol and compile Ruby with OpenSSL 1.0.1 or higher.

Microsoft WinINet

Compatible with the most recent, stable version

  • Windows Server 2012 R2 and higher
  • Windows 8.1 and higher

Compatible by default

  • Windows Server 2008 R2 to 2012
  • Windows 7 and 8

Compatible by default if Internet Explorer 11 is installed. If Internet Explorer 8, 9, or 10 is installed, then TLS 1.1 and TLS 1.2 will need to get enabled by the user or an administrator for compatibility. Review the Enabling TLS 1.1 and TLS 1.2 in Internet Explorer article to enable TLS 1.1 or higher encryption.

  • Windows Server 2008 and below
  • Windows Vista and below

Not compatible with TLS 1.1 or higher encryption

Microsoft Secure Channel (Schannel)

Compatible with the most recent, stable version

  • Windows Server 2012 R2 and higher
  • Windows 8.1 and higher

Compatible by default

  • Windows Server 2012
  • Windows 8

TLS 1.1 and TLS 1.2 are disabled by default, but are available if enabled by an application. TLS 1.1 and TLS 1.2 can be enabled by default within the registry. Those registry settings are also available as a registry import file

  • Windows Server 2008 R2
  • Windows 7

Compatible by default in client mode when Internet Explorer 11 is installed. If Internet Explorer 11 is not installed TLS 1.1 and TLS 1.2 can be enabled by default within the registry. Those registry settings are also available as a registry import file. Some applications enable TLS 1.1 and TLS 1.2 without either these registry settings or Internet Explorer 11.

  • Windows Server 2008 and below
  • Windows Vista and below

Not compatible with TLS 1.1 or higher encryption

OpenSSL

Compatible with the most recent, stable version, regardless of operating system

OpenSSL 1.0.1 and higher

Compatible by default

OpenSSL 1.0.0 and below

Not compatible with TLS 1.1 or higher encryption

Mozilla NSS

Compatible with the most recent, stable version, regardless of operating system

3.15.1 and higher

Compatible by default

3.14 to 3.15

Compatible with TLS 1.1, but not with TLS 1.2

3.13.6 and below

Not compatible with TLS 1.1 or higher encryption

New API Method – Retrieve Event Attendees

A long-awaited expansion to our Event API has arrived. On Saturday, December 12 a new method will become available: Retrieve Event Attendees. This allows you to retrieve a list of attendees for a single event, including attendee standard fields, attendee custom fields, and a couple of registrant fields.

Head over to the documentation for more information: http://help.neoncrm.com/api/rest/events/retrieveEventAttendees

API to Production Status

We are pleased to announce that the NeonCRM API is finally transitioning from beta to production-level status.

This change will take effect as part of our July feature release on Saturday, July 11th. As a member of NeonCRM’s API development community, you might be wondering what this means for the future of your API-based application.

All API methods will continue to work as they do now.

No changes are being made to existing API methods as part of this announcement.

The API is now subject to a Service Level Agreement.

Continued use of the API requires that you agree to abide by these terms. The service level agreement can be viewed here.

The level of API support will be higher.

API-related support requests and bug fixes will now be given the same level of priority as those related to the NeonCRM core application.

We thank you for participating in NeonCRM’s API beta phase. Your feedback and insights have been critical to bringing our API to its current level.

Notice of change to RSS feed structure

In order to ensure NeonCRM’s RSS feeds remain in compliance with standards, we will be modifying the structure of our feeds. This change is being applied in order to address certain problems that were reported by customers using our RSS feeds with web-based RSS readers.

Changes

The following modifications will take effect on April 18, 2015:

  • The <dc:date> property will be removed. The date included in this property is the same date as the <pubDate> field, just in a different format. If your application relies on the <dc:date> property, you will need to modify your code to use <pubDate> instead.

To see examples of the current RSS feeds, please follow the links below:

Upcoming Events Feed:
https://demo.z2systems.com/np/feed?orgId=demo

News Feed:
https://demo.z2systems.com/np/feed?segment=news&orgId=demo

Important Change Notice for NeonCRM API – Search Methods

As part of a major structural overhaul to NeonCRM’s core reporting system, we will be changing the names of a significant number of reporting columns and criteria. These changes will likely require modifications to your application’s code. This change necessarily affects the following API methods:

  • listAccounts
  • listDonations
  • listEvents
  • listMemberships

We have written a complete description of the changes and outlined the necessary steps to keep your application functioning.

Click here to view the migration guide.

Specific Upgrade Information

  • The upgrade will take place January 17, 2015 from 12:00AM to 3:00AM CST.
  • The Current Field Names will function until the upgrade.
  • The New Field Names will function after the upgrade.
  • There will be no overlap period where both names will work.

Impact

Many names of columns and criteria will change. Field names, as they existed prior to this update, will cease to work. Developers must update their code to use the new field names.

New API Features – September 2014

As part of our core feature release this month, we have included some new capabilities for existing API methods.

Trigger system emails for transactions

You can now automatically trigger system emails when you create new records through the API. This works on the following API methods:

Implementation is simple; just add a parameter to your request:

sendAcknowledgeEmail=true

These emails follow whatever behavior has been configured in NeonCRM’s system settings. In order for these to work, you must configure these system emails. The settings are shared with the system emails used by NeonCRM’s built-in online forms. If you create any email conditions in NeonCRM, they will apply here as well.

Event Summary

The Event Summary field is now available for use as an output column in the listEvents method.

New API Features – April 2014

We’re excited to announce the release of some new updates to the API. The following features will be made available on Monday, April 21:

New Methods

We have added the following new methods:

syncAccounts

Query the server to find accounts that have been recently updated.

listAccountsBySearchCriteria

This is a simplified and faster version of listAccounts. It has pre-set output columns and a limited set of search criteria.

listAccountsByKeywordSearch

This is an account search that is similar to the search box in the upper-right corner of NeonCRM. It searches for accounts by Name, Email, or Account ID.

retrieveActivity

Retrieve a single activity record.

syncActivities

Query the server to find activities that have been recently updated.

retrieveCurrentSystemUser

Retrieve the account ID of the current system user.

Adjustments to Existing Methods

We have made modifications to the following methods:

retrieveOrganizationAccount

Added a new parameter (primaryContactAccountId) to RetrieveOrganizationAccount request.

listAccounts

The reporting logic behind this request has changed. In the previous logic, if an individual and their linked organization both have accounts and the search result returns both account, the response lists them as one entry instead of two. With the new logic, two separate accounts will be returned.

The search criteria and output columns have also been updated.

API Available for Production Environment

For the past few months, API access has been limited to sandbox environments. After testing for several months, we have gained a lot of useful feedback from our user community. This feedback has been very helpful in allowing us to fine-tune our API. We have fixed many bugs, improved performance and reliability, and expanded the available features.

We have decided to allow the API functionality to be enabled on live NeonCRM environments. Our API remains in beta, so all usage on a production environment is at your own risk.

If you would like us to enable your system, please send a request to projects (at) z2systems.com. The following guide explains how to create API keys in a production environment: https://z2.zendesk.com/entries/21818899