api

Documentation

Index

• func DeleteKey(id string) bool
• func GetSystemKey() string
• func IsValidApiKey(key string, modifyTime bool, requiredPermission uint8) bool
• func NewKey(defaultPermissions bool) string
• func Process(w http.ResponseWriter, r *http.Request, maxMemory int)

Functions

func DeleteKey

func DeleteKey(id string) bool

DeleteKey deletes the selected API key

func GetSystemKey

func GetSystemKey() string

GetSystemKey returns the latest System API key or generates a new one, if none exists or the current one expires within the next 24 hours

func IsValidApiKey

func IsValidApiKey(key string, modifyTime bool, requiredPermission uint8) bool

IsValidApiKey checks if the API key provides is valid. If modifyTime is true, it also automatically updates the lastUsed timestamp

func NewKey

func NewKey(defaultPermissions bool) string

NewKey generates a new API key

func Process

func Process(w http.ResponseWriter, r *http.Request, maxMemory int)

Process parses the request and executes the API call or returns an error message to the sender