Proposal API help
From MikroTik Wiki
Revision as of 22:48, 19 April 2014 by Boen robot (talk | contribs) (Created page with "= Introduction = == Abstract == The API protocol, unlike the command line (and by extension - the Telnet and SSH protocols), does not offfer a way for RouterOS to report to the ...")
Introduction
Abstract
The API protocol, unlike the command line (and by extension - the Telnet and SSH protocols), does not offfer a way for RouterOS to report to the client the available commands, menus, attributes or attribute values. This proposal suggests a new API protocol specific command called "/help" that behaves similarly to a "?" in the command line, in that it will fill this gap, and it should hopefully be relatively easy to implement by MikroTik due to its similarity with the "?" help.
Terminology
- API protocol - The syntax defined in the corresponding manual page.
- API client - A general purpose implementation of the API protocol for use in a programming language. All "Examples" at the end of the above manual page are essentially API clients.
- (API) application - A program or script written in a programming language that uses an API client as part of its functionality.
- Users - People using API clients inside their applications or otherwise interact directly with the API protocol.
- End users - People for which the "Users" write the API applications.
