50 lines
1.7 KiB
HTML
50 lines
1.7 KiB
HTML
{{ define "title" }}API Documentation{{ end }}
|
|
|
|
{{ define "head" }}
|
|
{{ end }}
|
|
|
|
{{ define "body" }}
|
|
<p>API Requests can be made by making a POST request to /generate</p>
|
|
|
|
<p>The request body should be JSON similar to the below</p>
|
|
|
|
<pre>
|
|
<code>
|
|
{
|
|
"barcode_type": "code128",
|
|
"width": 600,
|
|
"height": 100,
|
|
"ecc_level": 4,
|
|
"content": "45684562"
|
|
}
|
|
</code>
|
|
</pre>
|
|
|
|
<p><code>barcode_type</code> should be one of:</p>
|
|
<ul>
|
|
{{range .BarcodeOptions}}
|
|
<li>{{.}}</li>
|
|
{{end}}
|
|
</ul>
|
|
|
|
<p><code>width</code> and <code>height</code> are in pixels - PDF417 is a fixed size and these options will only change the canvas size.</p>
|
|
|
|
<p><code>ecc_level</code> should be 1, 2, 3 or 4 where 1 is least resilient and 4 is most resilient</p>
|
|
|
|
<p><code>content</code> should be the value you wish the barcode to display. This should be a string and may not accept all characters - that is dependent on the barcode type.</p>
|
|
|
|
<p>The response will be a PNG image</p>
|
|
|
|
<h2>Formatted Barcodes</h2>
|
|
|
|
<p>Formatted barcodes are under development, this API endpoint <code>/generate/format</code> will produce a QR, Aztec or Datamatrix barcode with one of the following formats:</p>
|
|
<ul>
|
|
<li>WiFi Network</li>
|
|
<li>Contact (vCard)</li>
|
|
<li>Contact (MeCard)</li>
|
|
<li>Event (VCS)</li>
|
|
<li>Event (ICS)</li>
|
|
<li>Phone Number</li>
|
|
</ul>
|
|
<p>Note that URLs have no special formatting and can be produced as plain text barcodes using the <code>/generate</code> endpoint</p>
|
|
{{ end }} |