What is an API?
API stands for Application Programming Interface. An API is a software interface that allows applications to communicate with one another to perform specific tasks, such as moving the members list and data from one Ning network to another, or creating new member profiles on your Ning network based on a member list you’ve exported from somewhere else.
How can the Ning 3.0 APIs help me?
The Ning 3.0 API’s have been released so that developers can design applications that can communicate with a Ning Network and expand the functionality of the Ning platform.
For example, developers could use the the Ning 3.0 APIs for –
- Custom Mobile Apps – Create a native mobile app for your Ning Network on iPhone, Android, Blackberry or Windows Phone devices.
- Desktop Apps – Integrate your network with desktop activity dashboard viewers, media editing applications and more.
- Content Importers – Develop content importers and bridges for third-party blogging tools, photo services, etc.
- Content Exporters – Display or process content or member data from a Ning Network on other web properties in ways not possible with RSS (e.g. a business directory).
- eCRM synchronization – Synchronize network member data with a third-party email solution such as Mailchimp or CRM solution such as Salesforce.
- New Network Features – Build a custom Ning Network feature that accesses content or member data in the network (e.g. a job board or classifieds marketplace)
- Import Members or Customers – Create member profiles for all organization members or business customers at the launch of a Ning Network.
- WordPress Import – Turn your WordPress site into a Ning Community.
Access to the Ning 3.0 APIs is included in all Ning 3.0 subscription plans, including Ning Basic, Ning Performance and Ning Business.
Ning API Example
Pinkfroot has created both Plane Finder and Ship Finder. These mobile apps allow you to track planes and ships worldwide. They use the Ning APIs to offer a job board, classifieds, directory, pull in profile data (including profile question responses) and to deliver a great experience to members. They also pull in content from the network (e.g. photos) to deliver greater value with the mobile app.
Overview of Ning 3.0 API Calls
One reason we developed the Ning 3.0 APIs is to facilitate network migration from the Ning 2 platform to the Ning 3.0 platform. This means that almost all actions, content and data in a Ning 3.0 Network can be accessed through the Ning 3.0 APIs.
What calls are allowed in each feature?
- BlogPost: create, update, delete, get, query
- Discussion: create, delete, get, query
- Photo: create, delete, get, query
- Comment: create, update, delete, get, query
- Group: create, update, delete, get, query
- Message: create, update, delete, get, query
- User: create, get (Network Creator only)
- SitePage: create, get
- Bundle: get
- Network: get
For details of these calls, see: Ning 3.0 API Documentation
You may find the following documents helpful:
You may also find the following Ning 2 API documents helpful (much of this still applies for Ning 3.0):
Getting Started Basics
Step 1: Get a Ning Network
Working with a Network Creator?
If you or your client already has a Ning Network, you can get started right away by developing on a test network. All Ning networks have API access.
Independent developer?
Get started by creating a Ning trial network (14 days free).
Step 2: Generate an API Key
Once you have access to a Ning Network, you’ll need to generate consumer credentials for your application. The consumer credentials identify your application when it accesses the Ning Network. You can generate up to twenty different keys for different applications.
To generate a developer key, visit the following page on your Ning Network (swapping the “NAME” portion for your network’s subdomain) : API KEY URL GOES HERE
Step 3: Check out Docs and Code Samples
Familiarize yourself with the API by reading the API overview section of the documentation.
Start coding by checking out our examples:
Step 4: Join the Community
The developer community gives you access to API resources and an ability to connect with other API developers.
