API Beta Release
Today we are announcing the beginning of beta testing for our API. This long-anticipated project comes at a time of unprecedented opportunity for collaboration and sharing of data between applications. As NeonCRM grows, we are proud to welcome you as partners in the evolution of our platform.
What can I do with the API?
Right now, we’re starting simple. The first API, now available to testers, is the Accounts API. You can use this to retrieve, create, edit, and delete account data. You can also use this to manage households, link individuals to organizations, and view an account’s activities. We are actively developing APIs to work with Donations, Memberships, Events, and the Online Store. These will be released to beta testers at a later time.
Specifications
To try to make everyone happy, we developed our APIs for both RESTful and SOAP protocols. The REST APIs can return both JSON and XML formats, and uses an API key for authentication.
Beta Testing
The beta testing period will last for an undetermined amount of time. We want to put the API through its paces before we make it available for all clients. As a beta tester, you will receive the following:
- A duplicate “sandbox” version of your existing NeonCRM system.
- An API key which provides access to API requests.
At this point in time, you cannot use API features on your “live” NeonCRM system. Also, we will periodically solicit feedback from beta testers.
Support
The API is not supported in the same way as the rest of NeonCRM. Please do not submit tickets, live chat requests, or phone calls to the support team. Instead, please direct all inquries to the API Forum. We encourage you to contribute to our community of experienced users.
Let’s get started!
Organizations that have requested beta testing access will receive an email with their API key and their testing sandbox. To become a beta tester, please email us at projects [at] z2systems.com. Your request may take 2-3 business days to process.