Announcing the API


We’re happy to finally announce the 1.0 production launch of our API! It’s been in the oven a long time, but we really wanted to work out any kinks before finally pushing it out. The time has finally come and we’re ready to launch!

What’s the point?

There are so many things we want to do on Obsidian Portal. We’d love to build an importer for .dnd4e files. We want to make an iPhone and Android mobile app. We want to make it easy to export your campaign data into desktop campaign management software like Masterplan. The list goes on and on. But, we simply don’t have the time or resources to do everything. With the API, other developers can step in and enhance Obsidian Portal to make the tools you want. You will be able to integrate Obsidian Portal with other websites, your mobile devices, and all kinds of other applications. Your campaign will follow you where you go, instead of being isolated on the main Obsidian Portal site.

Who’s it for?

While the API is here to serve everyone, in the beginning we will need some pretty savvy technical people to start making applications and integrations for it. We need mobile developers, web app developers, and anyone else who wants to integrate Obsidian Portal campaigns into their favorite websites and applications. If you know of a project or application that would benefit from integrating with Obsidian Portal, please contact the people involved and tell them to get in touch with us. Or, if you have an idea you’d like to explore, please reach out. We’re eager to help get people on board.

How can I get started?

If you’re a developer with an idea, check out our API Overview for information on getting started. I’ve also set up a subforum for API related discussions. Drop in and let us know what you’re planning and what we can do to help. I haven’t been as active on the forum as I’d like, but I’ll do my best to keep a closer eye on discussions in the API subforum and answer any technical questions I can.

What’s next?

We want to get people up and running on the API as soon as possible. To that end, follow us on Twitter and Facebook for announcements regarding the API. We’re hoping to run some contests in the near future with prizes awarded to the best and most novel apps that people can create. If you have ideas for apps, or ideas for rewards we can offer to app developers, leave a comment and let us know!

This API could be a huge paradigm shift in managing your campaign with Obsidian Portal. The possibilities are almost limitless and we can’t wait to see what people come up with!

Leave a Reply

Your email address will not be published. Required fields are marked *

  1. I’m you’re basic end user still trying to figure out html code. I think maybe I understand what an API is maybe but I doubt I could explain it. I have no idea if it is of any use to me or my campaign. In fact, I’m not sure but I think it might only be fore use with D&D 4th edition.

    I clicked on the link provided that was supposed to provide an overview. I looked at the documents. All I saw was a few lines of baffling text and lots of programing code/ macros. Please if this is meant for me, the basic end user, I need much more explanation and documentation.

    Thank you for your time and consideration.

  2. Chaiya,

    Please read the section above titled ‘Who’s It For?” We need programmers who want to integrate Obsidian Portal data into their existing programs.

    Also, it’s useful for much more than 4E.

  3. Cool!…The API sounds really promising, and is exactly what I was looking for when I joined this site. I’m not working on any kind of wrapper, but I am working on a character generator for World of Darkness games (currently Changeling only, but I hope to get it working for vampires, werewolves, etc.) written in Rails that will hopefully be really easy to integrate into Obsidian Portal. I’ll also check out the mage-hand wrapper, and will definitely take a look at it.

    – Rob

    (p.s. link to char generator: http://changeling-chargen.heroku.com/; source code repo: https://github.com/bobbert/ChangelingChargen)

  4. I’m mega-pleased that everyone is giving the API a try. I can’t wait to see all the great apps that people are building!