(BLOCK (PARA (TEXT "The API (short for ") (FORMAT-QUOTE () (FORMAT-STRONG () (TEXT "A")) (TEXT "pplication ") (FORMAT-STRONG () (TEXT "P")) (TEXT "rogramming ") (FORMAT-STRONG () (TEXT "I")) (TEXT "nterface")) (TEXT ") is the primary way to communicate with a running Zettelstore.") (SOFT) (TEXT "Most integration with other systems and services is done through the API.") (SOFT) (TEXT "The ") (LINK-ZETTEL () "00001014000000" (TEXT "web user interface")) (TEXT " is just an alternative, secondary way of interacting with a Zettelstore.")) (HEADING 1 () "background" "background" (TEXT "Background")) (PARA (TEXT "The API is HTTP-based and uses plain text and ") (LINK-ZETTEL () "00001012930000" (TEXT "symbolic expressions")) (TEXT " as its main encoding formats for exchanging messages between a Zettelstore and its client software.")) (PARA (TEXT "There is an ") (LINK-ZETTEL () "00001012920000" (TEXT "overview zettel")) (TEXT " that shows the structure of the endpoints used by the API and gives an indication about its use.")) (HEADING 1 () "authentication" "authentication" (TEXT "Authentication")) (PARA (TEXT "If ") (LINK-ZETTEL () "00001010040100" (TEXT "authentication is enabled")) (TEXT ", most API calls must include an ") (LINK-ZETTEL () "00001010040700" (TEXT "access token")) (TEXT " that proves the identity of the caller.")) (UNORDERED (INLINE (LINK-ZETTEL () "00001012050200" (TEXT "Authenticate an user")) (TEXT " to obtain an access token")) (INLINE (LINK-ZETTEL () "00001012050400" (TEXT "Renew an access token")) (TEXT " without costly re-authentication")) (INLINE (LINK-ZETTEL () "00001012050600" (TEXT "Provide an access token")) (TEXT " when doing an API call"))) (HEADING 1 () "zettel-lists" "zettel-lists" (TEXT "Zettel lists")) (UNORDERED (INLINE (LINK-ZETTEL () "00001012051200" (TEXT "List all zettel"))) (INLINE (LINK-ZETTEL () "00001012051400" (TEXT "Query the list of all zettel"))) (INLINE (LINK-ZETTEL () "00001012051600" (TEXT "Determine a tag zettel"))) (INLINE (LINK-ZETTEL () "00001012051800" (TEXT "Determine a role zettel")))) (HEADING 1 () "working-with-zettel" "working-with-zettel" (TEXT "Working with zettel")) (UNORDERED (INLINE (LINK-ZETTEL () "00001012053200" (TEXT "Create a new zettel"))) (INLINE (LINK-ZETTEL () "00001012053300" (TEXT "Retrieve metadata and content of an existing zettel"))) (INLINE (LINK-ZETTEL () "00001012053400" (TEXT "Retrieve metadata of an existing zettel"))) (INLINE (LINK-ZETTEL () "00001012053500" (TEXT "Retrieve evaluated metadata and content of an existing zettel in various encodings"))) (INLINE (LINK-ZETTEL () "00001012053600" (TEXT "Retrieve parsed metadata and content of an existing zettel in various encodings"))) (INLINE (LINK-ZETTEL () "00001012054200" (TEXT "Update metadata and content of a zettel"))) (INLINE (LINK-ZETTEL () "00001012054600" (TEXT "Delete a zettel")))) (HEADING 1 () "various-helper-methods" "various-helper-methods" (TEXT "Various helper methods")) (UNORDERED (BLOCK (PARA (LINK-ZETTEL () "00001012070500" (TEXT "Retrieve administrative data")))) (BLOCK (PARA (LINK-ZETTEL () "00001012080100" (TEXT "Execute some commands"))) (UNORDERED (INLINE (LINK-ZETTEL () "00001012080200" (TEXT "Check for authentication"))) (INLINE (LINK-ZETTEL () "00001012080500" (TEXT "Refresh internal data")))))))