API documentation

This site handles HTTP GET requests to / and /create_marker/<message>

Sample examples from a terminal:

$ curl http://getsmartmarker.augumenta.com/
... returns the html page with the form
$ curl http://getsmartmarker.augumenta.com/create_marker/svg
Error: payload missing or null.

API

NOTE: This API currently only support SVG generation and a payload size of 3 bytes. Larger payloads, more flexible marker sizes, central logos and PNG or PDF outputs are possible; contact us for more details.

Routes Description
GET /create_marker/svg The payload argument is required. Error will be returned if not supplied.
GET /create_marker/svg?payload=01A3F5 The created SVG has marker payload (00)01A3F5. The payload is made of hexadecimal number (0-9 and A-F characters only). Its length is equal to twice the user_payload_length parameter (6, 10 or 18 characters). Note that the leading double-zero should not be entered as it cannot be modified. All other settings are set to default.
GET /create_marker/svg?payload=01A3F5&user_payload_length=3 The payload length selector between 3, 5 and 9 bytes. Default is 3. More bytes means bigger markers.
GET /create_marker/svg?payload=01A3F5&size_exponent=0 The size factor of the marker. The final size sill be (2^size_exponent) times the normal marker size. Normal marker sizes are 90mm for 3-bytes payload, 100mm for 5-bytes payload and 110mm for 9-bytes payload. The size_exponent ranges from -3 and 4 and the default value is zero.
GET /create_marker/svg?payload=01A3F5&show_marker_size=on Show the marker dimensions in the created SVG.
GET /create_marker/svg?payload=01A3F5&show_ref_marks=on Show the reference marks in the created SVG.
GET /create_marker/svg?payload=01A3F5&show_payload=on Show the marker payload in the created SVG.
GET /create_marker/svg?payload=01A3F5&add_payload_to_filename=on Add the payload string to the filename, i.e., file name will be marker-00123456.svg instead of the default marker.svg

Libraries