Ips News New: Additional REST API Endpoints

[ADMIN 322]

This is an entry about our IPS Community Suite 4.2 release and features content specifically aimed towards developers. If you are not interested in developing for 4.2 you may wish to skip this entry. Don't worry we still have lots of exciting core feature announcements still to come. 

We are expanding on the already available REST API endpoints to include more support for nodes. This significantly increases the flexibility of the API and now allows forums, downloads categories, calendars etc. to be created programmatically via external sources.

 As is usual with the existing content item endpoints, access for nodes is configured via the admin control panel for each API key that is generated.

Configuring API Permissions via the Admin Control Panel

For those new to the REST API, documentation can be found in the developer resources section and within the admin control panel.

Endpoint Documentation

New endpoints in 4.2 include;

• GET /core/groups - Get a list of groups
• GET /core/groups/{id} - Get information about a specific group
• DELETE /core/groups/{id} - Delete a group
• GET /forums/forums - Get a list of forums
• GET /forums/forums/{id} - Get information about a specific forum
• POST /forums/forums - Create a forum
• POST /forums/forums/{id} - Edit a forum
• DELETE /forums/forums/{id} - Delete a forum
• DELETE /blog/blogs/{id} - Delete a blog
• GET /calendar/calendar - Get a list of calendars
• GET /calendar/calendar/{id} - Get information about a specific calendar
• POST /calendar/calendar - Create a calendar
• POST /calendar/calendar/{id} - Edit a calendar
• DELETE /calendar/calendar/{id} - Delete a calendar
• GET /downloads/category - Get a list of downloads categories
• GET /downloads/category/{id} - Get information about a specific category
• POST /downloads/category - Create a category
• POST /downloads/category/{id} - Edit a category
• DELETE /downloads/category/{id} - Delete a category

We are continuously looking for ways to improve developer functionality so if you have any ideas for additional endpoints or suggestions for improved documentation please feel free to share them in the comments below.

We are really looking forward to seeing the new and imaginative ideas 3rd party developers can create using these additional capabilities.

 

View the full article