((p "The API (short for " (@L (@H "“") (strong "A") "pplication " (strong "P") "rogramming " (strong "I") "nterface" (@H "”")) ") 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 . "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"))))))