System information

Manual:API
160
API sentences
API sentence is main object of communication using API.
•• Empty sentences are ignored.
•• Sentence is processed after receiving zero length word.
•• There is a limit on number and size of sentences client can send before it has logged in.
• Order of attribute words should not be relied on. As order and count is changeable by .proplist attribute.
•• Sentence structure is as follows:
• First word should contain command word;
• Should contain zero length word to terminate the sentence;
• Can contain none or several attribute words. There is no particular order at what attribute words has to be sent
in the sentence, order is not important for attribute words;
• Can contain none or several query words. Order of query words in the sentence is important.
Note: Zero length word terminates the sentence. If it is not provided router will not start to evaluate sent
words and will consider all the input as part of the same sentence.
Initial login
/login
!done
=ret=ebddd18303a54111e2dea05a92ab46b4
/login
=name=admin
=response=001ea726ed53ae38520c8334f82d44c9f2
!done
Note: that each command and response ends with an empty word.
• First, clients sends /login command.
• Reply contains =ret=challenge argument.
• Client sends second /login command, with =name=username and
=response=response.
• In case of error, reply contains =ret=error message.
•• In case of successful login client can start to issue commands.