As part of our scheduled feature release on Saturday, December 15, we will be changing the API endpoint URL for NeonCRM trials.
We are no longer supporting this endpoint for trials:
https://api.neoncrm.com/neonws/
Instead, as of December 15, API requests made to trial systems must now be made to this endpoint:
https://trial.z2systems.com/neonws/
This change only affects NeonCRM Trial systems. We are making no changes to the API endpoint for production NeonCRM systems.
We have updated the NeonCRM API to include additional fields as part of our effort towards GDPR compliance. You can read more about the project here.
The updated methods include the new consent data fields found in NeonCRM. These methods have been updated:
A number of API methods will be updated to include stronger permission controls. These permissions have largely been in place for existing API methods, but on May 5, 2018 we will be releasing a number of updates to tighten permissions.
If your application encounters permission errors, please check the permission settings for the system user account associated with your API key. You can refer to NeonCRM’s guide to System User Groups and Permissions for more information about updating permissions.
For reference, here is a list of the NeonCRM user permissions required to use each API method.
| API Method | Permissions |
|---|---|
| updatePaymentRequest | Edit Donation, Edit Membership, Edit Registration, Edit Order |
| retrieveStatsRequest | View Donation |
| listActivitiesRequest | View Activity, Include Activity Report, View Report |
| listSystemUsersRequest | View Account |
| createIndividualAccountRequest | New Account |
| updateIndividualAccountRequest | Edit Account |
| editIndividualAccountRequest | Edit Account |
| retrieveIndividualAccountRequest | View Account |
| retrieveOrganizationAccountRequest | View Account |
| createOrganizationAccountRequest | New Account |
| updateOrganizationAccountRequest | Edit Account |
| editOrganizationAccountRequest | Edit Account |
| linkIndividualToOrganizationRequest | Edit Account |
| removeIndividualFromOrganizationRequest | Edit Account |
| listOrganizationContactsRequest | View Account |
| listAccountsRequest | View Account, View Report, Report Communication |
| listAccountsByDefaultRequest | View Account |
| syncAccountsRequest | View Account |
| listFavoriteAccountsRequest | View Account |
| addToFavoriteAccountsRequest | View Account |
| removeFromFavoriteAccountsRequest | View Account |
| listAccountsByKeywordSearchRequest | View Account |
| listAccountsBySearchCriteriaRequest | View Account |
| addAddressRequest | Edit Account |
| updateAddressRequest | Edit Account |
| removeAddressRequest | Edit Account |
| addActivityRequest | New Activity |
| updateActivityRequest | Edit Activity |
| removeActivityRequest | Delete Activity |
| createHouseHoldRequest | Edit Account |
| updateHouseHoldRequest | Edit Account |
| addIndividualToHouseHoldRequest | Edit Account |
| removeIndividualFromHouseHoldRequest | Edit Account |
| updateHouseHoldPrimaryRequest | Edit Account |
| deleteHouseHoldRequest | Edit Account |
| syncActivitiesRequest | View Activity |
| retrieveActivityRequest | View Activity |
| listEventsRequest | View Event, View Report, Include Event Report |
| retrieveEventRegistrationStatsRequest | View Registration |
| retrieveEventAttendeesRequest | View Registration |
| createEventRegistrationRequest | New Registration |
| calculateEventRegistrationRequest | New Registration |
| listEventTicketsRequest | View Event |
| listFundsRequest | View Campaign |
| listCampaignsRequest | View Campaign |
| listPurposesRequest | View Campaign |
| createDonationRequest | New Donation |
| createRecurringDonationRequest | New Donation |
| createPledgeRequest | New Pledge |
| createPledgePaymentRequest | Edit Pledge |
| listDonationsRequest | View Donation, View Report, Include Donation Report |
| listRecurringDonorsRequest | View Donation, View Account |
| retrieveDonationStatsRequest | View Donation |
| retrieveCampaignSummaryRequest | View Campaign |
| listMembershipsRequest | View Membership, View Report, Include Membership Report |
| listMembershipTermsRequest | View Membership |
| addMembershipToAccountRequest | New Membership |
| listMembershipHistoryRequest | View Membership |
| retrieveMembershipStatsRequest | View Membership |
| listCatalogsRequest | View Catalog |
| createCatalogRequest | New Catalog |
| updateCatalogRequest | Edit Catalog |
| removeCatalogRequest | Delete Catalog |
| addProductToCatalogRequest | Edit Catalog |
| removeProductFromCatalogRequest | Edit Catalog |
| listCategoriesRequest | Edit Store Product Types |
| createCategoryRequest | Edit Store Product Types |
| updateCategoryRequest | Edit Store Product Types |
| removeCategoryRequest | Edit Store Product Types |
| listProductsRequest | View Product, Edit Store Product Types |
| createProductRequest | New Product |
| updateProductRequest | Edit Product |
| removeProductRequest | Delete Product |
| retrieveProductRequest | View Product |
| uploadProductImageRequest | View Product |
| removeProductImageRequest | Edit Product |
| listProductImagesRequest | View Product |
| createProductOptionRequest | Edit Product |
| listProductOptionsRequest | View Product |
| updateProductOptionRequest | Edit Product |
| removeProductOptionRequest | Edit Product |
| createShoppingCartRequest | New Order |
| addItemToShoppingCartRequest | New Order |
| removeItemFromShoppingCartRequest | New Order |
| addOrUpdateShippingAddressToShoppingCartRequest | New Order |
| listShippingMethodsRequest | New Order |
| addOrUpdateCustomerToShoppingCartRequest | New Order |
| retrieveShoppingCartSummaryRequest | New Order |
| checkoutRequest | New Order |
| retrieveOrderDetailsRequest | View Order |
| listOrdersRequest | View Order |
| retrieveReceiptRequest | View Order, View Receipts |
| retrieveStorePurchaseStatsRequest | View Order |
We have updated the List Custom Object Records method to implement paginated results and searching for records. This means you can retrieve a subset of records (rather than retrieving all records at the same time).
You can view the updated documentation here: https://developer.neoncrm.com/api/custom-objects/list-custom-object-records/
The long-awaited capability to use NeonCRM’s API to create event registrations is here. With this update, we get three new API methods:
Please check out the documentation and feel free to submit your questions to the developer forum.
We have released the ability to create Custom Objects in NeonCRM via the API. This feature is considered to be in an open beta phase. While we do not expect to make significant changes to the overall functionality, we may make incremental improvements and fixes as necessary. The beta period is expected to last approximately three months.
You can read more about custom objects here: https://developer.neoncrm.com/api/custom-objects/
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.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 |
|
Compatible by default |
|
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. |
|
Not compatible with TLS 1.1 or higher encryption |
|
Microsoft Secure Channel (Schannel) |
Compatible with the most recent, stable version |
|
Compatible by default |
|
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. |
|
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. |
|
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 |
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
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.
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.
The following modifications will take effect on April 18, 2015:
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