Creating an API – First Steps

Let's Connect!Over our lifetime, we’ve gotten a handful of requests for an API. In every case, our answer was, “We really want to do this, but just don’t have the time right now.” Well, we’re tired of that answer, and have decided to make some time. We’re super-excited about the idea of third-party developers making cool integrations with Obsidian Portal, and we can’t wait to see what cool stuff you all come up with.

Getting Started

Obsidian Portal is a fairly complex system now, with lots of heterogeneous data. Users, campaigns, wiki pages, adventure log posts, characters, items, maps, images, and surely some other stuff I’m forgetting. It would take forever to build API hooks for all of that data, so we’re going to take some baby steps first. The first phase will (probably) be read-only that exposes a fraction of our data for consumption by third party apps. This is where we need your help: What do you want?

There’s no point in us making an API unless some of you are writing apps to consume our data. We’ve got a few people we’re already talking to, but we want to include as much feedback as possible. If you’re interested, please let us know what you’re thinking.

Basically, I need answers to the following questions:

  1. What are you planning to do?
  2. What data do you need from Obsidian Portal?

If you have ideas, come to the forum and discuss it in the API thread.

Keep it serious

Before anyone starts throwing out ideas and requests, I’d like to make it clear that we plan to focus on actual developers and actual applications. I don’t want to get dragged into theoretical “It’d be cool if…” brainstorming. There are a lot of possibilities here, and I want the initial push to be in the direction of something concrete, even if it’s not earth-shattering.


Our motto is “Under promise, Over deliver” and I intend to hold to that here. I’m not going to give a definitive timeline, and instead say that hopefully we will have something stable by the end of 2010, or early 2011.

Award Winning!

Gold ENnie for Best Website 09'-11'

Silver ENnie for Best Website, Best Podcast 2012-2013
Petrified Articles
© Copyright 2010-2024 Words In The Dark. All rights reserved. Created by Dream-Theme — premium wordpress themes. Proudly powered by WordPress.