-
Notifications
You must be signed in to change notification settings - Fork 7
/
api-doc.html
132 lines (112 loc) · 4.2 KB
/
api-doc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!DOCTYPE html>
<html lang="en">
<head>
<title>NomenMatch</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link href='http://fonts.googleapis.com/css?family=Roboto|Slabo+27px&subset=latin,latin-ext' rel='stylesheet' type='text/css'>
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
<link href="//maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" crossorigin="anonymous"></script>
<link href="css/default.css" rel="stylesheet">
</head>
<body>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63174146-1', 'auto');
ga('send', 'pageview');
</script>
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-2">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href='index.html' style="color:#fff" >NomenMatch</a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-2">
<ul class="nav navbar-nav">
<li><a href="about.html">About</a></li>
<li><a href="index.html">Match</a></li>
<li><a href="howto.html">How-To</a></li>
<li><a href="#">API</a></li>
</ul>
</div>
</div>
</div>
<!-- introduction panel -->
<div class="container">
<div class="page-header">
<h1>NomenMatch API documentation</h1>
</div>
note: you can use & to combine multiple API functions, for example:
<pre><code>api.php?names=Machilus+thunbergii&format=table</code></pre>
<h2 class="blog-post">api.php</h2>
<div class="panel panel-info">
<div class="panel-heading">
<h3 class="panel-title">names</h3>
</div>
<div class="panel-body">
<table class="table table-striped">
<tr>
<td>description</td><td>scientific names, to separate multiple names by pipe (|)</td>
</tr>
<tr>
<td>values</td><td>text</td>
</tr>
<tr>
<td>examples</td><td><a href="api.php?names=Machilus+thunbergii|Taiwania+cryptomerioides">api.php?names=Machilus+thunbergii|Taiwania+cryptomerioides</a></td>
</tr>
</table>
</div>
</div>
<div class="panel panel-info">
<div class="panel-heading">
<h3 class="panel-title">format</h3>
</div>
<div class="panel-body">
<table class="table table-striped">
<tr>
<td>description</td><td>export format</td>
</tr>
<tr>
<td>values</td><td>table,csv,json,plain</td>
</tr>
<tr>
<td>examples</td><td><a href="api.php?names=Taiwania+cryptomerioides&format=csv">api.php?names=Taiwania+cryptomerioides&format=csv</a></td>
</tr>
</table>
</div>
</div>
<div class="panel panel-info">
<div class="panel-heading">
<h3 class="panel-title">best</h3>
</div>
<div class="panel-body">
<table class="table table-striped">
<tr>
<td>description</td><td>best results only</td>
</tr>
<tr>
<td>values</td><td>yes,medium,no</td>
</tr>
<tr>
<td>examples</td><td><a href="api.php?names=Taiwania+cryptomerioides&best=yes">api.php?names=Taiwania+cryptomerioides&best=yes</a></td>
</tr>
</table>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="text-muted">NomenMatch © Jason Mai (TaiBIF/TaiBON Team)</p>
</div>
</footer>
</body>
</html>