Sign In
•
Register
Discussions
Sign In
Close
Home
›
Micah2
›
Comments
Micah2
Comments
Micah2
in
Dynamic Character Sheets via the API
December 2010
Currently, it would work like this: Web apps - Normal OAuth flow. Redirect users to our OAuth authorize page, when they accept, they're redirected back to the web app along with their credentials. Mobile / Desktop app - Embed your consumer key…
Micah2
in
Dynamic Character Sheets via the API
December 2010
We're trying to come up with a good-enough solution, even if it's not perfect. Someone described OAuth as a "bad solution to a horrible problem" and I think it's a pretty good description. It's not great, but it's better than something I could come …
Micah2
in
Dynamic Character Sheets via the API
December 2010
edited December 2010
Also, the main sticking point here (that I can see) is how to do OAuth in a desktop application. Does every person who downloads it need to create their own OP app in order to get a client key and secret? Or does every instance of the desktop app us…
Micah2
in
Dynamic Character Sheets via the API
December 2010
Hitting the API every 30s is fine. Things might get hairy if you're hitting it every 5s, but 30s should be no problem. Also, there is no issue with having in-development html, css, or javascript in the DST. That's what the review process is for. …
Micah2
in
Dynamic Character Sheets via the API
December 2010
I agree about not reinventing the wheel. I don't want a new text editor. Instead, the app just knows the paths to your text files on disk. You use your favorite text editor to edit them normally. When you want to see how it looks, you click a button…
Micah2
in
Dynamic Character Sheets
December 2010
I've added DSTs to the API. You can see more here: http://help.obsidianportal.com/faqs/api/api-dynamic-sheet-templates I have a cool idea on how to use this. I'll put up a blog post with more info.
Micah2
in
Obsidian Portal API discussion
December 2010
Just deployed the mini-object update. I'll be updating the docs tonight. Also, I've added Dynamic Sheet Templates (DSTs) to the list of objects that can be queried via the API. My hope is to make the DST authoring process much easier. We'll see h…
Micah2
in
Obsidian Portal API discussion
December 2010
I just checked in a change to switch all user references to mini-objects, and the same for campaign references. It changes things from "XXX_id" to just "XXX". So, for example, "fan_ids" becomes "fans" and is just an array of mini-objects. Looking…
Micah2
in
Obsidian Portal API discussion
December 2010
edited December 2010
I doubt fans will be needed all that much. And you're right that 196 characters is much, much less expensive than another request. One other thing I'm trying to minimize is database joins on our end. The more data we pull together to return in a req…
Micah2
in
Emissary, cool stuff...
December 2010
Make sure to send Dan an email.
[email protected]
Micah2
in
Obsidian Portal API discussion
December 2010
Also, what would be the return for the two paths you give? I would assume: /v1/campaigns/id/players.json - Returns all users (players + gm) for the given campaign /v1/users/id/campaigns.json - Returns all campaigns for the given user Assum…
Micah2
in
Obsidian Portal API discussion
December 2010
edited December 2010
Steve, Thanks. This is the exact kind of feedback I'm looking for. Ways to make the API more useful and reduce requests. What if in every case where we return user ids, we return a mini-object like this: @'user' : { 'id' : 'abcd', 'user…
Micah2
in
Obsidian Portal API discussion
December 2010
Just wanted to pass along a cool API-related story from today... Someone sent me an email asking if we could integrate Google Wave into the site. Considering that it would only help a very small number of people, it's not something we're really i…
Micah2
in
Obsidian Portal API discussion
November 2010
We'll be removing the visibility field from characters tonight...
Micah2
in
Obsidian Portal API discussion
November 2010
One other note: I don't want to discourage people from writing language wrappers, but I would strongly suggest writing the wrapper in tandem with an API application that actually does something. Without a test app, there's really no way to know how …
Micah2
in
Obsidian Portal API discussion
November 2010
A few thoughts: 1) play_status can be: "planning", "in_play", "hiatus", or "completed" 2) We're approaching API from an "additions only" standpoint. Once we're satisfied with things we'll call it 1.0 and from then on, we won't remove or (massi…
Micah2
in
Obsidian Portal API discussion
November 2010
I just pushed a couple updates. I've added some fields to the User and Campaign models, most notably the URL for the user and campaign images. This will make it much easier to add a personalized touch for whoever is logging in via the API.
Micah2
in
Obsidian Portal API discussion
November 2010
It's a bit of a secret that adventure log posts are just "special" wiki pages. So, they can be retrieved now by pulling all the wiki pages and just filtering on those with a type of "Post". Then, order by "post_time" and you've got the adventure log…
Micah2
in
Obsidian Portal API discussion
November 2010
Only docs are what I've got up on help.obsidianportal.com There are only 5 or 6 pages for the API. Just save them all to disk and you've got everything.
Micah2
in
Obsidian Portal API discussion
November 2010
I updated the Characters API calls to allow for full CRUD functionality. That means there is full CRUD for wiki pages and characters. I'll take a look at the authorization client today and see if something is up with clients that don't have a red…
Micah2
in
Obsidian Portal API discussion
November 2010
Test app is "live on heroku":http://floating-stone-53.heroku.com I had no idea heroku was so easy. Also, the authorize access workflow is working normally for me. I click Authorize and it redirects me correctly back to my app. I'll keep looking t…
Micah2
in
Obsidian Portal API discussion
November 2010
I must have broken something with the auth page. I've been moving so fast on this I haven't been as good at testing as I should be. I'll go fix it. Don't read too much intelligence into my test app. I just banged it out as quickly as I could. The…
Micah2
in
Obsidian Portal API discussion
November 2010
I created a "test project":https://github.com/micahwedemeyer/obsidianportal_tag_renamer today on github. It actually might come in handy in the near future, as we're going to switch tags to being case-sensitive. People may want to rename a bunch of …
Micah2
in
Obsidian Portal API discussion
November 2010
Pushed the update live. I'll try to document the error responses sometime soon. For now, check out "the Wiki Page documentation":http://help.obsidianportal.com/faqs/api/api-wiki-pages It's pretty standard CRUD stuff, which I hope to stick to as m…
Micah2
in
Obsidian Portal API discussion
November 2010
An update: We're changing how errors are returned, so it can support returning multiple errors at once. Essentially, we want to be able to handle cases where some inputs are invalid ('name is too short' or 'email address invalid') and return a list …
Micah2
in
Obsidian Portal API discussion
November 2010
authorize_url isn't really documented anywhere. I had to dig through the code. Fair warning: in the code "authorize_url" is marked with a comment that says "TODO: This is ugly, fix it somehow" so maybe they don't plan to support it going forward. I …
Micah2
in
Obsidian Portal API discussion
November 2010
edited November 2010
Steve, I love the name. A nice melding of the Ruby community "name it something crazy" philosophy, aligned with the subject matter. I love it. Let me answer your questions as best I can: 1) I'm not sure I understand here, but it sounds like…
Micah2
in
Obsidian Portal API discussion
November 2010
Sorry, just saw these questions... We need to give some attention to all the OAuth pages, from client application signup to user authorization to client app editing. The ones you see here are pretty much the raw templates created by the oauth-plu…
Micah2
in
Obsidian Portal API discussion
November 2010
We updated the OAuth workflow URLs as well. They are now served via SSL and from the 'www' subdomain. More here: "http://help.obsidianportal.com/faqs/api/api-authentication-oauth":http://help.obsidianportal.com/faqs/api/api-authentication-oauth T…
Micah2
in
Obsidian Portal API discussion
November 2010
We made the updates to the API, and updated the documentation. The URLs are more Rails-y now, and I really like the UUIDs over the raw database IDs. Now to see about adding some more functionality to it.
More Comments
September 2026
City of Shadows
Read the
feature post
on the blog
Return to
Obsidian Portal
Micah2
Joined
February 2007
Visits
1
Last Active
January 2017
Roles
Member
Posts
894
Profile
Activity
Discussions
36
Comments
858
Howdy, Stranger!
It looks like you're new here. If you want to get involved, click one of these buttons!
Sign In
Register
Sign In
Forum
Home
Discussions
Activity
Conversations
Profile
Information
Terms of Use
Community Rules