Difference between revisions of "HTTP API"
From SmartBots Developers Docs
(Created page with "SmartBots HTTP API") |
|||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | SmartBots HTTP API | + | HTTP API allows controlling your Second Life bot using HTTP queries. The query can be send from SL object (LSL script), website code or your application. |
| + | |||
| + | == The basics == | ||
| + | |||
| + | Basically the API usage consists of the following steps: | ||
| + | |||
| + | # Compose the query and send it (using '''llHTTPRequest''' in case of LSL) | ||
| + | # Wait for the SmartBots reply (using '''http_response''' in case of LSL) | ||
| + | # Decode the reply. | ||
| + | |||
| + | Each SmartBots bot comes with HTTP API enabled. You just need to grab the [https://www.mysmartbots.com/docs/Bot_access_code bot's access code] (it is a kind of password for bot's API) and your unique [[HTTP_API/Developer's_API_key|Developer's API key]]. | ||
| + | |||
| + | == API Testing Suite == | ||
| + | |||
| + | There's a special page to compose and test HTTP API queries: https://www.mysmartbots.com/api/testing.html | ||
| + | |||
| + | == Usage == | ||
| + | |||
| + | === Raw code === | ||
| + | |||
| + | <syntaxhighlight lang="lsl"> | ||
| + | string params = llDumpList2String([ | ||
| + | "action=" + "get_balance", | ||
| + | |||
| + | "apikey=" + llEscapeURL(sbApiKey), | ||
| + | "botname=" + llEscapeURL(sbBotName), | ||
| + | "secret=" + llEscapeURL(sbBotAccessCode) | ||
| + | ], "&"); | ||
| + | |||
| + | llHTTPRequest("https://api.mysmartbots.com/api/bot.html", | ||
| + | [HTTP_METHOD,"POST"], params); | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Read [[HTTP_API/Doing_HTTP_API_Calls|Doing HTTP API Calls]] for more info. | ||
| + | |||
| + | === Helper functions === | ||
| + | |||
| + | We've written few helper functions to make HTTP API usage easier: | ||
| + | |||
| + | <syntaxhighlight lang="lsl"> | ||
| + | smartbotsAPI("status", []); | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Check [[HTTP API/LSL Helper Functions|LSL Helper Functions]] for more info on helpers. | ||
| + | |||
| + | === More examples === | ||
| + | |||
| + | Check [[HTTP_API/Examples|HTTP API examples]] to see how HTTP API works in LSL. | ||
| + | |||
| + | |||
| + | {{NavMenu}} | ||
Latest revision as of 15:46, 14 October 2019
HTTP API allows controlling your Second Life bot using HTTP queries. The query can be send from SL object (LSL script), website code or your application.
Contents
The basics
Basically the API usage consists of the following steps:
- Compose the query and send it (using llHTTPRequest in case of LSL)
- Wait for the SmartBots reply (using http_response in case of LSL)
- Decode the reply.
Each SmartBots bot comes with HTTP API enabled. You just need to grab the bot's access code (it is a kind of password for bot's API) and your unique Developer's API key.
API Testing Suite
There's a special page to compose and test HTTP API queries: https://www.mysmartbots.com/api/testing.html
Usage
Raw code
string params = llDumpList2String([
"action=" + "get_balance",
"apikey=" + llEscapeURL(sbApiKey),
"botname=" + llEscapeURL(sbBotName),
"secret=" + llEscapeURL(sbBotAccessCode)
], "&");
llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
[HTTP_METHOD,"POST"], params);
Read Doing HTTP API Calls for more info.
Helper functions
We've written few helper functions to make HTTP API usage easier:
smartbotsAPI("status", []);
Check LSL Helper Functions for more info on helpers.
More examples
Check HTTP API examples to see how HTTP API works in LSL.
