ApiDocs - Revision history

Janrinok: /* Foreword */

2024-11-27T16:21:35Z

Foreword

← Older revision		Revision as of 16:21, 27 November 2024
Line 2:		Line 2:

	==Foreword==		==Foreword==
	This is the documentation for the ~~upcoming~~ SoylentNews API ~~that I'm working on~~. It is currently live but it's possible it may cease to be that way. In the ~~event that it doesn't though, I want it documented so people can actually start building against it right off~~.		This is the documentation for the SoylentNews API. It may be updated with new functions in the future. It is currently live but it's possible it may cease to be that way. Access to some functions may be restricted based on the users Seclev.

	==Layout==		==Layout==

Janrinok: /* Methods */

2024-11-27T16:17:40Z

Methods

← Older revision		Revision as of 16:17, 27 November 2024
Line 16:		Line 16:
	** operations on stories such as getting the latest or a single story		** operations on stories such as getting the latest or a single story
	* journal		* journal
	** ~~not yet implemented~~		** operations on journals such as getting the latest journal or a series of journals
	* auth		* auth
	** ~~not yet implemented~~		** logging in to the API
	* default		* default
	** any other method currently returns an empty 200 status. error text would not be a bad idea though.		** any other method currently returns an empty 200 status. error text would not be a bad idea though.

The Mighty Buzzard at 11:51, 12 February 2016

2016-02-12T11:51:00Z

← Older revision		Revision as of 11:51, 12 February 2016
Line 66:		Line 66:
	* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl. Use the topiclist op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>		* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl. Use the topiclist op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>
	** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>		** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
	* nexuslist - returns an array of hashes containing data on every nexus ~~(dev only)~~		* nexuslist - returns an array of hashes containing data on every nexus
	** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
	* topiclist - returns an array of hashes containing data on every topic ~~(dev only)~~		* topiclist - returns an array of hashes containing data on every topic
	** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
	* default - any other op returns an empty 200 status. error text would not be a bad idea though.		* default - any other op returns an empty 200 status. error text would not be a bad idea though.

The Mighty Buzzard: /* story ops */

2016-02-12T11:49:50Z

story ops

← Older revision		Revision as of 11:49, 12 February 2016
Line 64:		Line 64:
	* reskey - returns a reskey for later use in the post op. takes no arguments.		* reskey - returns a reskey for later use in the post op. takes no arguments.
	** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
	* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <br/> On dev you may use the ~~<b>~~topiclist~~</b> story~~ op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>		* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl. Use the topiclist op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>
	** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>		** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
	* nexuslist - returns an array of hashes containing data on every nexus (dev only)		* nexuslist - returns an array of hashes containing data on every nexus (dev only)

The Mighty Buzzard: /* story ops */

2016-02-12T11:46:39Z

story ops

← Older revision		Revision as of 11:46, 12 February 2016
Line 64:		Line 64:
	* reskey - returns a reskey for later use in the post op. takes no arguments.		* reskey - returns a reskey for later use in the post op. takes no arguments.
	** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
	* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <b>On dev you may use the topiclist story op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>		* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <br/> On dev you may use the <b>topiclist</b> story op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>
	** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>		** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
	* nexuslist - returns an array of hashes containing data on every nexus (dev only)		* nexuslist - returns an array of hashes containing data on every nexus (dev only)

The Mighty Buzzard: /* story ops */

2016-02-12T11:45:34Z

story ops

← Older revision		Revision as of 11:45, 12 February 2016
Line 54:		Line 54:

	===story ops===		===story ops===
	* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. ~~<b>On dev you~~ may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.~~</b>~~		* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. You may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
	** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
	** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>

Crutchy: /* Example scripts */

2015-12-02T09:01:17Z

Example scripts

← Older revision		Revision as of 09:01, 2 December 2015
Line 97:		Line 97:
	There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure		There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
	<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>		<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

			The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
			For example, to get the uid of the latest comment:
			<pre>~api m=comment op=latest /0/uid</pre>

	[[Category:Development]]		[[Category:Development]]

The Mighty Buzzard: /* story ops */

2015-08-20T12:15:58Z

story ops

The Mighty Buzzard: /* story ops */

2015-08-19T14:36:29Z

story ops

← Older revision		Revision as of 14:36, 19 August 2015
Line 64:		Line 64:
	* reskey - returns a reskey for later use in the post op. takes no arguments.		* reskey - returns a reskey for later use in the post op. takes no arguments.
	** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
	* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education<br><b>~~twenty~~ seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>		* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <b>An op needs to be added to be able to pull story topics for when they change.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>
	** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>		** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
			* nexuslist - returns an array of hashes containing data on every nexus (dev only)
			** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
	* default - any other op returns an empty 200 status. error text would not be a bad idea though.		* default - any other op returns an empty 200 status. error text would not be a bad idea though.

The Mighty Buzzard: /* auth ops */

2015-08-15T11:00:21Z

auth ops

← Older revision		Revision as of 11:00, 15 August 2015
Line 80:		Line 80:
	===auth ops===		===auth ops===
	*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.		*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
	**<pre>https://~~dev.~~soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>		**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

	==Errata==		==Errata==

← Older revision		Revision as of 12:15, 20 August 2015
Line 54:		Line 54:

	===story ops===		===story ops===
	* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50.		* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. <b>On dev you may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.</b>
	** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
	** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
Line 64:		Line 64:
	* reskey - returns a reskey for later use in the post op. takes no arguments.		* reskey - returns a reskey for later use in the post op. takes no arguments.
	** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
	* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <b>An op ~~needs to be added to be able~~ to ~~pull story~~ topics ~~for when they change~~.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>		* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional.<br>POST method is absolutely required for submissions<br>primaryskid should be set to 1 until nexuses are working<br>sub_type should be either "plain" or "html"<br>reskey comes from a previous call to the m=story&op=reskey op<br>name, subj, and story are up to you<br>tid the topic and is the same as the values on submit.pl:<br> 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education <b>On dev you may use the topiclist story op to obtain a current list of topics.</b><br><b>Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data</b>
	** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>		** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
	* nexuslist - returns an array of hashes containing data on every nexus (dev only)		* nexuslist - returns an array of hashes containing data on every nexus (dev only)
	** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>		** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
			* topiclist - returns an array of hashes containing data on every topic (dev only)
			** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
	* default - any other op returns an empty 200 status. error text would not be a bad idea though.		* default - any other op returns an empty 200 status. error text would not be a bad idea though.