Difference between revisions of "Documentation/Nightly/Developers/Tutorials/ObtainExtensionServerApiKey"

From Slicer Wiki
Jump to: navigation, search
(Created page with '== Setting up an account and obtaining an API key == In order to upload extensions on the [slicer extensions server][], it is required to: # Create an account by [http://slicer…')
 
m
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Setting up an account and obtaining an API key ==
+
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
<noinclude>
 +
== Setting up an account and obtaining an API key ==</noinclude>
  
−
In order to upload extensions on the [slicer extensions server][], it is required to:
+
In order to upload extensions on the [http://slicer.kitware.com slicer extensions server], it is required to:
  
−
# Create an account by [http://slicer.kitware.com registering]
 
  
−
[[File:Slicer-midas-extensions-server-registration.png|800px|border]]
+
<ol start="1" style="list-style-type: decimal;">
  
−
<ol start="2" style="list-style-type: decimal;">
+
{{:Documentation/{{documentation/version}}/Developers/Tutorials/CreateMidasAccount/steps}}
  
−
<li><p>[http://slicer.kitware.com/midas3/community/23 Join the NA-MIC community]</p></li>
+
<li><p>Retrieve your API key looking at your account details:</p>
  
−
<li><p>Send an email on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel slicer developers list] presenting your extension(s) and asking to be granted write permission on the [http://slicer.kitware.com/midas3/folder/253 experimental folder].</p></li>
+
<ol start="1" style="list-style-type: decimal;">
 +
<li>Go to http://slicer.kitware.com. If needed, signin by clicking on <code>Login</code> in the top right corner.</li>
 +
<li>Click on your name in the top right corner.</li>
 +
<li>Click on <code>My account</code>.</li>
 +
<li>Click on <code>API</code> tab.</li>
 +
<li><p>Copy the <code>API Key</code> associated with <code>Default</code> application.</p>
 +
 
 +
  <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">
 +
  <li><p>There is currently a bug preventing api key containing non alpanumeric characters from being used.<br>
 +
If your Default api key contain for example a <code>/</code>, '''try to delete the api key and regenerate one''' that is not containing "/" and is named <code>Default</code>.<br>
 +
We are working on the issue to update the build system so that it properly escape "/" and also get in touch with Midas team so that api key containing just number and letter are generated.</p></li>
 +
  </ol>
 +
</li>
 +
</ol>
 +
 
 +
</li>
 +
[[File:Slicer-midas-extensions-server-obtaining-api-key.png|900px|border]]
  
−
<li><p>Then, you should be able to retrieve your API key looking at your account details. Note that any one of the API key associated with a given user account is valid. It's the user role to manage its keys.</p></li>
 
  
 
</ol>
 
</ol>
−
 
−
[[File:Slicer-midas-extensions-server-obtaining-api-key.png|800px|border]]
 

Latest revision as of 15:18, 27 August 2013

Home < Documentation < Nightly < Developers < Tutorials < ObtainExtensionServerApiKey


For the latest Slicer documentation, visit the read-the-docs.


Setting up an account and obtaining an API key

In order to upload extensions on the slicer extensions server, it is required to:


  1. Create an account on the extension server: http://slicer.kitware.com by clicking on the Register link in the top right corner

    2. Slicer-midas-extensions-server-registration.png

    This image shows the top portion of http://slicer.kitware.com after it has been expanded by clicking the Register button.

  2. Go to NA-MIC community and click on Join community

  3. Retrieve your API key looking at your account details:

    1. Go to http://slicer.kitware.com. If needed, signin by clicking on Login in the top right corner.
    2. Click on your name in the top right corner.
    3. Click on My account.
    4. Click on API tab.

    5. Copy the API Key associated with Default application.

      1. There is currently a bug preventing api key containing non alpanumeric characters from being used.
        If your Default api key contain for example a /, try to delete the api key and regenerate one that is not containing "/" and is named Default.
        We are working on the issue to update the build system so that it properly escape "/" and also get in touch with Midas team so that api key containing just number and letter are generated.

    4. Slicer-midas-extensions-server-obtaining-api-key.png
Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/Tutorials/ObtainExtensionServerApiKey&oldid=34695"