Jump to content

Invision Community Blog


Managing successful online communities

Andy Millne
Sign in to follow this  
 

New: Additional REST API Endpoints

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.

apiperms.png

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.

apidocs.png

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.

 

    Sign in to follow this  

    Comments

    Recommended Comments

    Nice additions but we surely need PM and Login support, please have them in mind for the final version.

    Also Andy could you explain more the part " This significantly increases the flexibility of the API and now allows forums, downloads categories, calendars etc. to be created programmatically via external sources". 

    Thanks

    Share this comment


    Link to comment
    Share on other sites

    Just curious because I am not sure I fully understand the above feature. Does this mean that I can have someone code me a page that could simultaneously create multiple sections? For example, I usually have to create a Download Category called "X" and then create a Gallery Category called "X" and then an IP Pages DB Category called "X".

    Share this comment


    Link to comment
    Share on other sites

    Looks like you forgot to add GET/POST endpoints for blog? I see only a DELETE one listed for the blogs app otherwise?

    Quote
    • DELETE /forums/forums/{id} - Delete a forum
    • DELETE /blog/blogs/{id} - Delete a blog
    • GET /calendar/calendar - Get a list 

     

    Share this comment


    Link to comment
    Share on other sites
    On 4/8/2017 at 9:46 AM, Phillyman said:

    Just curious because I am not sure I fully understand the above feature. Does this mean that I can have someone code me a page that could simultaneously create multiple sections? For example, I usually have to create a Download Category called "X" and then create a Gallery Category called "X" and then an IP Pages DB Category called "X".

    Yes, these containers can now be created programatically (and even from remote servers).

    Share this comment


    Link to comment
    Share on other sites
    7 hours ago, bfarber said:

    Yes, these containers can now be created programatically (and even from remote servers).

    Oh that would be so helpful, my site deals with hundreds of categories that are mirrored between Content, Downloads and Gallery and it would cut down on the creation process.

    Share this comment


    Link to comment
    Share on other sites

    And what's about group's name when multiple language are defined ? Currently, if without correct language (and even sometimes with correct one) it can return something like that :
     

    {
      "id": 3,
      "name": "77b67ab3dd272b3ff2a8480c3eedce71",
      "formattedName": "<span style='color:#105289'>77b67ab3dd272b3ff2a8480c3eedce71<\/span>"
    }

    It might be a good idea to make group name to default language in case of error instead of returns this kind of string

    Share this comment


    Link to comment
    Share on other sites
    1 hour ago, TLeM4 said:

    And what's about group's name when multiple language are defined ? Currently, if without correct language (and even sometimes with correct one) it can return something like that :
     

    
    {
      "id": 3,
      "name": "77b67ab3dd272b3ff2a8480c3eedce71",
      "formattedName": "<span style='color:#105289'>77b67ab3dd272b3ff2a8480c3eedce71<\/span>"
    }

    It might be a good idea to make group name to default language in case of error instead of returns this kind of string

    If the group name is not returning correctly as in your example, that would be a bug and I would encourage you to submit a ticket with details so we can take a look.

    Share this comment


    Link to comment
    Share on other sites

    I'm desperate for someone to create an SSO solution for 'Eve Online' boards. A gaming community with great number of IP Board forums.

    Ideally, an SSO to replace the existing login/registration handler using the developers SSO solution:

    https://esi.tech.ccp.is/latest/

    The SSO can check and pass the users 'corporation history' through: https://esi.tech.ccp.is/latest/#!/Character/get_characters_character_id_corporationhistory

    • If that player is in the correct Corporation, register him at the lowest membership level
    • consider interval checks to see if that player is still in the Corporation and remove them if not

    Combined with the awesome TeamSpeak app - this would then complete the full suite!
     

    If anyone would consider looking at the above solution, funds for payment are available and I'm sure a great number of Ipboard /Eve player corporations would purchase future downloads from the market place.

    Edited by ADAM MCGINLAY

    Share this comment


    Link to comment
    Share on other sites

    Join the conversation

    You can post now and register later. If you have an account, sign in now to post with your account.
    Note: Your post will require moderator approval before it will be visible.

    Guest
    Add a comment...

    ×   Pasted as rich text.   Paste as plain text instead

      Only 75 emoji are allowed.

    ×   Your link has been automatically embedded.   Display as a link instead

    ×   Your previous content has been restored.   Clear editor

    ×   You cannot paste images directly. Upload or insert images from URL.

    Loading...