(((meta (@ (content . "API") (name . "title"))) (meta (@ (content . "manual") (name . "role"))) (meta (@ (content . "#api #manual #zettelstore") (name . "tags"))) (meta (@ (content . "zmk") (name . "syntax"))) (meta (@ (content . "00001000000000 00001004010000 00001004020000 00001004051000 00001005000000 00001007720900 00001010000000 00001012920500 00001019990010") (name . "back"))) (meta (@ (content . "00001000000000 00001004010000 00001004020000 00001004051000 00001005000000 00001007720900 00001010000000 00001012053200 00001012920500 00001014000000 00001019990010") (name . "backward"))) (meta (@ (content . "1") (name . "box-number"))) (meta (@ (content . "(c) 2020-present by Detlef Stern <ds@zettelstore.de>") (name . "copyright"))) (meta (@ (content . "20210126175322") (name . "created"))) (meta (@ (content . "00001010040100 00001010040700 00001012050200 00001012050400 00001012050600 00001012051200 00001012051400 00001012051600 00001012051800 00001012053200 00001012053300 00001012053400 00001012053500 00001012053600 00001012054200 00001012054400 00001012054600 00001012070500 00001012080100 00001012080200 00001012080500 00001012920000 00001012930000 00001014000000") (name . "forward"))) (meta (@ (content . "en") (name . "lang"))) (meta (@ (content . "EUPL-1.2-or-later") (name . "license"))) (meta (@ (content . "20231128183617") (name . "modified"))) (meta (@ (content . "20231128183617") (name . "published"))) (meta (@ (content . "public") (name . "visibility")))) (p "The" " " "API" " " "(short" " " "for" " " (@L (@H "&ldquo;") (strong "A") "pplication" " " (strong "P") "rogramming" " " (strong "I") "nterface" (@H "&rdquo;")) ")" " " "is" " " "the" " " "primary" " " "way" " " "to" " " "communicate" " " "with" " " "a" " " "running" " " "Zettelstore." " " "Most" " " "integration" " " "with" " " "other" " " "systems" " " "and" " " "services" " " "is" " " "done" " " "through" " " "the" " " "API." " " "The" " " (a (@ (href . "00001014000000")) "web" " " "user" " " "interface") " " "is" " " "just" " " "an" " " "alternative," " " "secondary" " " "way" " " "of" " " "interacting" " " "with" " " "a" " " "Zettelstore.") (h2 (@ (id . "background")) "Background") (p "The" " " "API" " " "is" " " "HTTP-based" " " "and" " " "uses" " " "plain" " " "text" " " "and" " " (a (@ (href . "00001012930000")) "symbolic" " " "expressions") " " "as" " " "its" " " "main" " " "encoding" " " "formats" " " "for" " " "exchanging" " " "messages" " " "between" " " "a" " " "Zettelstore" " " "and" " " "its" " " "client" " " "software.") (p "There" " " "is" " " "an" " " (a (@ (href . "00001012920000")) "overview" " " "zettel") " " "that" " " "shows" " " "the" " " "structure" " " "of" " " "the" " " "endpoints" " " "used" " " "by" " " "the" " " "API" " " "and" " " "gives" " " "an" " " "indication" " " "about" " " "its" " " "use.") (h2 (@ (id . "authentication")) "Authentication") (p "If" " " (a (@ (href . "00001010040100")) "authentication" " " "is" " " "enabled") "," " " "most" " " "API" " " "calls" " " "must" " " "include" " " "an" " " (a (@ (href . "00001010040700")) "access" " " "token") " " "that" " " "proves" " " "the" " " "identity" " " "of" " " "the" " " "caller.") (ul (li (a (@ (href . "00001012050200")) "Authenticate" " " "an" " " "user") " " "to" " " "obtain" " " "an" " " "access" " " "token") (li (a (@ (href . "00001012050400")) "Renew" " " "an" " " "access" " " "token") " " "without" " " "costly" " " "re-authentication") (li (a (@ (href . "00001012050600")) "Provide" " " "an" " " "access" " " "token") " " "when" " " "doing" " " "an" " " "API" " " "call")) (h2 (@ (id . "zettel-lists")) "Zettel" " " "lists") (ul (li (a (@ (href . "00001012051200")) "List" " " "all" " " "zettel")) (li (a (@ (href . "00001012051400")) "Query" " " "the" " " "list" " " "of" " " "all" " " "zettel")) (li (a (@ (href . "00001012051600")) "Determine" " " "a" " " "tag" " " "zettel")) (li (a (@ (href . "00001012051800")) "Determine" " " "a" " " "role" " " "zettel"))) (h2 (@ (id . "working-with-zettel")) "Working" " " "with" " " "zettel") (ul (li (a (@ (href . "00001012053200")) "Create" " " "a" " " "new" " " "zettel")) (li (a (@ (href . "00001012053300")) "Retrieve" " " "metadata" " " "and" " " "content" " " "of" " " "an" " " "existing" " " "zettel")) (li (a (@ (href . "00001012053400")) "Retrieve" " " "metadata" " " "of" " " "an" " " "existing" " " "zettel")) (li (a (@ (href . "00001012053500")) "Retrieve" " " "evaluated" " " "metadata" " " "and" " " "content" " " "of" " " "an" " " "existing" " " "zettel" " " "in" " " "various" " " "encodings")) (li (a (@ (href . "00001012053600")) "Retrieve" " " "parsed" " " "metadata" " " "and" " " "content" " " "of" " " "an" " " "existing" " " "zettel" " " "in" " " "various" " " "encodings")) (li (a (@ (href . "00001012054200")) "Update" " " "metadata" " " "and" " " "content" " " "of" " " "a" " " "zettel")) (li (a (@ (href . "00001012054400")) "Rename" " " "a" " " "zettel")) (li (a (@ (href . "00001012054600")) "Delete" " " "a" " " "zettel"))) (h2 (@ (id . "various-helper-methods")) "Various" " " "helper" " " "methods") (ul (li (p (a (@ (href . "00001012070500")) "Retrieve" " " "administrative" " " "data"))) (li (p (a (@ (href . "00001012080100")) "Execute" " " "some" " " "commands")) (ul (li (a (@ (href . "00001012080200")) "Check" " " "for" " " "authentication")) (li (a (@ (href . "00001012080500")) "Refresh" " " "internal" " " "data"))))))