Difference between revisions of "API"

From AMPRNet
Jump to: navigation, search
m (added links to all references to the portal)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
The AMPRNet Portal has an associated API that allows the data and functionality of the Portal to be accessed programatically.
+
The AMPRNet [[Portal]] has an associated API that allows the data and functionality of the [[Portal]] to be accessed programatically.
  
 
Version 1 of the API uses a RESTful design, accessible only via SSL (https://) to increase security.
 
Version 1 of the API uses a RESTful design, accessible only via SSL (https://) to increase security.
Line 6: Line 6:
 
All requests to the API require the client to authenticate by using Basic HTTP authentication,  
 
All requests to the API require the client to authenticate by using Basic HTTP authentication,  
 
so you will need a username and password in order to access any part of the API,  
 
so you will need a username and password in order to access any part of the API,  
this can be obtained by registering for an account on the Portal.
+
this can be obtained by registering for an account on the [[Portal]].
  
Once you have an account, you can create your API Key (password) from the "Profile' menu link, in the "Security" section.
+
Once you have an account, you can create your API Key (password) from the "Profile' menu link, in the "Security" section of the [[Portal]].
The API username is the same username you used to login to the Portal via your web browser.
+
The API username is the same username you used to login to the [[Portal]] via your web browser.
  
Full details of how to use the API, along with examples, can be found once you login to the Portal, under the "API" menu link.
+
Full details of how to use the API, along with examples, can be found once you login to the [[Portal]], under the "API" menu link.

Latest revision as of 02:33, 28 July 2015

The AMPRNet Portal has an associated API that allows the data and functionality of the Portal to be accessed programatically.

Version 1 of the API uses a RESTful design, accessible only via SSL (https://) to increase security.

All requests to the API require the client to authenticate by using Basic HTTP authentication, so you will need a username and password in order to access any part of the API, this can be obtained by registering for an account on the Portal.

Once you have an account, you can create your API Key (password) from the "Profile' menu link, in the "Security" section of the Portal. The API username is the same username you used to login to the Portal via your web browser.

Full details of how to use the API, along with examples, can be found once you login to the Portal, under the "API" menu link.