API - Revision history

KI5QKX: mw push

2026-03-01T00:14:35Z

mw push

2026-02-27T19:06:24Z

mw push

← Older revision		Revision as of 19:06, 27 February 2026
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.

2024-12-20T14:44:32Z

Version 2

← Older revision		Revision as of 14:44, 20 December 2024
Line 24:		Line 24:
	browse your profile and copy the value of "API Token".		browse your profile and copy the value of "API Token".

	~~Some responses~~ are in [https://www.json.org JSON] format. Requests should include a header:		Responses are in [https://www.json.org JSON] format. Requests should include a header:

	Accept: application/json		Accept: application/json

2024-12-20T14:43:56Z

Version 1

← Older revision		Revision as of 14:43, 20 December 2024
Line 2:		Line 2:
	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 ===		=== Version 1 (DEPRECATED) ===

	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.

2024-12-12T20:22:44Z

← Older revision		Revision as of 20:22, 12 December 2024
Line 47:		Line 47:

	{"message":"Unauthenticated."}</nowiki>		{"message":"Unauthenticated."}</nowiki>


			[[Category:Reference]]

2024-10-15T18:50:13Z

document error handling

← Older revision		Revision as of 18:50, 15 October 2024
Line 37:		Line 37:
	To get the current serial number (but not the routes) in JSON,		To get the current serial number (but not the routes) in JSON,
	request <nowiki>https://portal.ampr.org/api/v2/encap/serial</nowiki>.		request <nowiki>https://portal.ampr.org/api/v2/encap/serial</nowiki>.

			If something goes wrong, the HTTP response may include
			an HTTP status code other than 200
			and/or an error message in the body.
			For example, a request with an invalid API token will elicit a response including:

			<nowiki>HTTP/1.1 401 Unauthorized
			Content-Type: application/json

			{"message":"Unauthenticated."}</nowiki>

2024-10-15T18:10:50Z

link to json.org

← Older revision		Revision as of 18:10, 15 October 2024
Line 24:		Line 24:
	browse your profile and copy the value of "API Token".		browse your profile and copy the value of "API Token".

	Some responses are in JSON format. Requests should include a header:		Some responses are in [https://www.json.org JSON] format. Requests should include a header:

	Accept: application/json		Accept: application/json

2024-10-15T01:12:13Z

Don't show API URLs as links.

← Older revision		Revision as of 01:12, 15 October 2024
Line 29:		Line 29:

	To get complete current routing information in JSON,		To get complete current routing information in JSON,
	request https://portal.ampr.org/api/v2/encap/routes .		request <nowiki>https://portal.ampr.org/api/v2/encap/routes</nowiki>.
	~~The response contains~~ a ~~serial number, which changes when any route is updated.~~		For example, a Unix command like this will output complete current routing information:
	~~To get the~~ current ~~serial number (but not the routes) in JSON,~~
	~~request https~~:~~//portal.ampr.org/api/v2/encap/serial .~~

	~~For example, a Unix command like this will output complete current routing information~~:		curl -s -H "Authorization: Bearer $APItoken" -H "Accept: application/json" <nowiki>https://portal.ampr.org/api/v2/encap/routes</nowiki>

	~~curl -s -H "Authorization: Bearer $APItoken" -H "Accept: application/json"~~ https://portal.ampr.org/api/v2/encap/~~routes~~		The response includes a serial number, which changes when any route is updated.
			To get the current serial number (but not the routes) in JSON,
			request <nowiki>https://portal.ampr.org/api/v2/encap/serial</nowiki>.

2024-10-15T00:51:37Z

Document the API version 2. I can't find any documentation of API version 1, nor any API documentation in https://portal.ampr.org .

@@ Line 1: / Line 1: @@
 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.
@@ Line 11: / Line 13: @@
 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.
+=== Version 2 ===

2023-08-16T17:26:48Z

← Older revision		Revision as of 17:26, 16 August 2023
Line 8:		Line 8:
	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 ~~of the [[Portal]]~~.		Once you have an account, you can create your API Key (password) from the "Profile' menu link, in the "Security" section.
	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.