438850API Center guide4378342009-04-28T02:10:43Zhttp://dev.springnote.com/pages/4388502007-08-28T01:25:21Z<h1><span style="color: rgb(255, 0, 0);">API Center</span></h1>
<p>Openmaru Studio currently provides services such as myID and Springnote and has a plan to provide more services in the future. API center has been established to help you use Openmaru service APIs.</p>
<p> </p>
<h3>API Center developer guide</h3>
<ul>
<li>Overview<br />
Every authentication for service APIs from Openmaru is performed through API Center. Therefore, you can manage applications at API Center in development by using the service APIs.<br />
API Center supports <a href="http://oauth.org/" class="external" title="http://oauth.org">OAuth</a> . Learning OAuth leads you to capability of authentication for not only Openmaru but also all the other service APIs compliant with OAuth.</li>
</ul>
<div class="section" style="background-color: rgb(249, 249, 216);">
<p style="text-align: center;"><span style="font-size: large;"><strong>Go to <a href="/pages/438869" title="API Center developer guide" class="wiki">API Center developer guide</a></strong></span></p>
</div>
<h3>API Center user guide</h3>
<ul>
<li>Overview<br />
In order to use applications with service APIs from Openmaru, you need user keys and can manage then at API Center.</li>
</ul>
<div style="text-align: center;"><span style="font-size: large;"><strong>Go to <a href="/pages/438868" title="API Center user guide" class="wiki">API Center user guide</a></strong></span></div>
<p> </p>
<p> </p>
<p> </p>
<p>Below is deprecated.</p>
<hr />
<p> </p>
<p>Openmaru Studio began Open API service by launching Open API for Springnote. A lot of mashup developers complained of complicated authentication process, and as a solution, API Center was established.</p>
<p> </p>
<h2 style="margin-left: 1em;"><span style="color: rgb(0, 128, 0);">Features</span></h2>
<p style="margin-left: 2em;">Openmaru Studio is planning to provide more Service APIs in addition to Springnote API. As the number of Service APIs increases, you'll have to register for each service used in your mashup, and it could be very annoying. However, if you use API Center, you only need to register once.</p>
<p style="margin-left: 2em;"> </p>
<p style="margin-left: 2em;">Also, you do not have to go to the service site to get and manage User Key for each service, because you can do it in one sweep at API Center.</p>
<p style="margin-left: 2em;"> </p>
<p style="margin-left: 2em;">Now, user can handle API User Key in two ways.</p>
<ol style="margin-left: 2em;">
<li>User Key for each service and each mashup is kept in API Center. When a particular mashup needs User Key, the mashup can request API Center for User Key.</li>
<li>Instead of requesting user for User Key directly, web application mashup can get User Key from API Center with permission of the user. Of course, user can manage these User Keys himself/herself in '[User] User Key Management'.</li>
</ol>
<p style="margin-left: 2em;"> </p>
<p style="margin-left: 2em;">Normally, if a mashup gets User Key through method #1, the mashup is likely a desktop mashup not based on web browser. If a mashup gets User Key through mehtod #2, the mashup is likely a web application mashup.</p>
<p style="margin-left: 2em;"> </p>
<p style="margin-left: 2em;">For a mashup developer, there is not much difference in building a desktop mashup, but there might be some extra work to handle authentication in building a web application mashup. Read <a href="/pages/438910" title="Browser based API authentication" class="wiki">Browser based API authentication</a> first for better understanding on API Center and then work through <a href="/pages/438978" title="tutorial" class="wiki">tutorial</a> .</p>
<p> </p>
<h1><span style="color: rgb(255, 0, 0);">What's the difference?</span></h1>
<ul>
<li><strong>Easy to use. </strong></li>
<li><strong>Automatic API Key management. </strong></li>
</ul>
<p>If a web application mashup is built using API Center, developers benefit from reduced work involved with getting API Keys, and users benefit from easier methods on getting and managing User Key.</p>
<p>You can also take full advantage of openID, while creating a mashup.</p>
<p> </p>
<p>Most mashups now available are combining a map and public resources. Mashups combining private information are very small in number, and unpopular. This is because user must have an account in each service, and register User Key to the mashup manually. API Center will provide a means to overcome these difficulties, and help you build more creative mashups.</p>
<p> </p>
<div class="section" style="background-color: rgb(249, 249, 216);">
<h4><span style="color: rgb(255, 0, 0);">Guide</span></h4>
<p>A guide for mashup users, and a guide for mashup developers are available.</p>
<p> </p>
<ul>
<li>
<p>For a guide on using API Center such as getting User Key, start with <a href="/pages/438868" title="API Center user guide" class="wiki">API Center user guide</a> .</p>
</li>
</ul>
<ul>
<li>For a guide relavant to developers such as registering application, start with <a href="/pages/438869" title="API Center developer guide" class="wiki">API Center developer guide</a> .</li>
</ul>
</div>
<p> </p>
<h1><span style="color: rgb(255, 0, 0);">Tutorial</span></h1>
<p>A tutorial for developers building a mashup using API Center. <a href="/pages/438978" title="[ Tutorial ]" class="wiki">[ Tutorial ]</a></p>
deepblueisotype51