View source for HTTP API/Doing HTTP API Calls

{{DISPLAYTITLE: Doing HTTP API Calls}}
To invoke HTTP API command, you have to call SmartBots API URL with required parameters. See the full list of HTTP Bot commands [[HTTP_API/Bot_Commands|here]].

The request can be either GET or POST. The returned value format is described down below.

== Passing parameters to API URL ==

Imagine you need to call [[HTTP_API/Bot_Commands/say_chat_channel|say_chat_channel]] command to say something in local chat.

# Take the Bot API URL: http://api.mysmartbots.com/api/bot.html
# Add required parameters
# Parse the response

The resulting query looks like this:

<syntaxhighlight lang="lsl">
string params = llDumpList2String([
  "action="  + "say_chat_channel",
  "apikey="  + llEscapeURL(yourApiKey),
  "botname=" + llEscapeURL("YourBot Resident"),
  "secret="  + llEscapeURL(botSecretCode),
  "channel=" + "0",
  "message=" + llEscapeURL("Hello there!")
  ],"&");

llHTTPRequest("http://api.mysmartbots.com/api/bot.html",
  [HTTP_METHOD,"POST"], params);
</syntaxhighlight>

== Parsing HTTP Reply ==

HTTP APIs return replies as a set of variables joined in the same way as URL parameters:

<syntaxhighlight lang="http">
result=FAIL&resulttext=BOT%20NOT%20EXISTS
</syntaxhighlight>

There are two standard return variables:

* '''result''' - takes one of two values:<br>OK - command completed successfully<br>FAIL - command failed
* '''resulttext''' - contains the detailed explaination of failed commands

Other return variables may contain the query results (for example, "groups" for [[listgroups (HTTP Bot Command)|listgroups]]).

== Testing ==

=== Demo and testing ===

You can compose and test your queries using SmartBots API Testing Suite: http://www.mysmartbots.com/api/testing.html

The working demo of SmartBots API is available in our office. [[BotArena Demo|Read this article]] for details.

== See also ==

Refer to [[HTTP API]] page for information on API commands available.

{{NavMenu}}

__NOTOC__