PsychoticNinja/Stikked
1
0
Fork 0
mirror of https://github.com/claudehohl/Stikked.git synced 2025-04-26 04:51:08 -05:00
Code Issues Projects Releases Wiki Activity

api docs

Browse Source
This commit is contained in:
Claude 2012-04-19 11:02:07 +02:00
parent 04f9b90c6c
commit 5bd2af5382
2 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
htdocs/application/views/api_help.php
View File

@ -1,8 +1,40 @@
<?php $this->load->view("defaults/header");?> <?php $this->load->view("defaults/header");?>
<div class="about"> <div class="api">
<h1>API</h1> <h1>API</h1>
Todo. <p class="explain border">Create pastes from the commandline</p>
<h2>API URL</h2>
<p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
<h2>POST parameters</h2>
<code>text=[your paste text]</code>
<p class="explain">The paste content. Required.</p>
<code>name=[name]</code>
<p class="explain">The author's name.</p>
<code>private=1</code>
<p class="explain">Make paste private.</p>
<h2>Return values</h2>
<p class="explain">
On success, the API returns the paste URL in JSON format: <code>{"url":"<?php echo site_url('view/68582786'); ?>"}</code><br />
On error, the API returns the error message in JSON format: <code>{"error":"missing paste text"}</code>
</p>
<h2>Examples</h2>
<p>&nbsp;</p>
<h3>Create paste</h3>
<code>curl -d text='this is my text' <?php echo site_url('api/create'); ?></code>
<p class="explain">Create a paste with the text 'this is my text'.</p>
<h3>Create paste from a file</h3>
<code>curl -d private=1 -d name=Herbert --data-urlencode text@/etc/passwd <?php echo site_url('api/create'); ?></code>
<p class="explain">Create a private paste with the author 'Herbert' and the contents of '/etc/passwd'.</p>
</div> </div>
<?php $this->load->view("defaults/footer");?> <?php $this->load->view("defaults/footer");?>

1
htdocs/application/views/defaults/header.php
View File

@ -35,6 +35,7 @@ $this->carabiner->display('css');
<?php $l = $this->uri->segment(1)?> <?php $l = $this->uri->segment(1)?>
<li><a <?php if($l == ""){ echo 'class="active"'; }?> href="<?php echo base_url()?>" title="Create A New Paste">Create</a></li> <li><a <?php if($l == ""){ echo 'class="active"'; }?> href="<?php echo base_url()?>" title="Create A New Paste">Create</a></li>
<li><a <?php if($l == "lists" || $l == "view" and $this->uri->segment(2) != "options"){ echo 'class="active"'; }?> href="<?php echo site_url('lists'); ?>" title="Recent Pastes">Recent</a></li> <li><a <?php if($l == "lists" || $l == "view" and $this->uri->segment(2) != "options"){ echo 'class="active"'; }?> href="<?php echo site_url('lists'); ?>" title="Recent Pastes">Recent</a></li>
<li><a <?php if($l == "api"){ echo 'class="active"'; }?> href="<?php echo site_url('api'); ?>" title="API">API</a></li>
<li><a <?php if($l == "about"){ echo 'class="active"'; }?> href="<?php echo site_url('about'); ?>" title="About">About</a></li> <li><a <?php if($l == "about"){ echo 'class="active"'; }?> href="<?php echo site_url('about'); ?>" title="About">About</a></li>
</ul> </ul>
</div> </div>