2023-09-03 20:52:51 +01:00
{{ define "title" }}API Documentation{{ end }}
2023-09-04 11:08:56 +01:00
{{ define "head" }}
{{ end }}
2023-09-03 20:52:51 +01:00
{{ define "body" }}
2023-09-01 22:47:46 +01:00
< 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 >
2023-09-01 23:01:08 +01:00
< 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 >
2023-09-01 22:47:46 +01:00
< p > < code > ecc_level< / code > should be 1, 2, 3 or 4 where 1 is least resilient and 4 is most resilient< / p >
2023-09-02 22:06:55 +01:00
< 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 >
2023-09-01 22:47:46 +01:00
< p > The response will be a PNG image< / p >
2023-09-03 20:52:51 +01:00
{{ end }}