Difference between revisions of "HTTP (API)"
From ComputerCraft Wiki
Pokepal101 (Talk | contribs) m (Removed NeedsWork tag. (see previous edit)) |
MKlegoman357 (Talk | contribs) m (fixed formatting) |
||
| (12 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
:{|class="wikitable" | :{|class="wikitable" | ||
| − | | '''The HTTP API must be enabled in | + | | '''The HTTP API must be enabled in ComputerCraft.cfg before being used. To enable it see [http://www.computercraft.info/forums2/index.php?/topic/17533-how-to-enable-the-http-api/ this tutorial].''' |
|} | |} | ||
The HTTP API allows interfacing with websites and downloading from them. | The HTTP API allows interfacing with websites and downloading from them. | ||
| − | + | {{API table|HTTP|image=Grid disk.png|2= | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | {{API table/row | |
| + | |[[http.request]]({{type|string}} url [, {{type|string}} postData [, {{type|table}} headers]]) | ||
| + | |{{type|nil}} | ||
| + | |Sends a HTTP request to a website, asynchronously. | ||
| + | |odd}} | ||
| − | + | {{API table/row | |
| − | + | |[[http.get]]({{type|string}} url [, {{type|table}} headers]) | |
| + | |{{type|table}} handle | ||
| + | |Sends a HTTP GET request to a website, synchronously. | ||
| + | |}} | ||
| − | + | {{API table/row | |
| − | + | |[[http.post]]({{type|string}} url, {{type|string}} postData [, {{type|table}} headers]) | |
| + | |{{type|table}} handle | ||
| + | |Sends a HTTP POST request to a website, synchronously. | ||
| + | |odd}} | ||
| − | + | {{API table/row | |
| − | + | |[[http.checkURL]]({{type|string}} url) | |
| − | + | |{{type|boolean}} success [<nowiki />, {{type|string}} error] | |
| + | |Checks if a URL is valid and is included in the HTTP whitelist. | ||
| + | |}} | ||
| − | + | }} | |
| + | |||
| + | [[http.request]] is used to send a HTTP request that completes asynchronously and generates an event (one of [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]]). [[http.get]] and [[http.post]] execute [[http.request]] and block until the operation completes. | ||
| + | |||
| + | == Handles == | ||
| + | All three operations make use of ''handles'', tables that contain functions to read data returned from the HTTP server. These handles act the same as the I/O handles returned by [[fs.open]] in read-only text mode, implementing the [[fs.open#Closing_a_file_handle|close]], [[fs.open#Files_opened_in_text_read_mode|readLine]], and [[fs.open#Files_opened_in_text_read_mode|readAll]] methods. These handles also implement the following function: | ||
| + | |||
| + | {{Function | ||
| + | |name=<var>h</var>.getResponseCode | ||
| + | |returns={{type|number}} HTTP response code | ||
| + | |api=HTTP | ||
| + | |desc=Returns the numerical [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response code] sent by the server | ||
| + | }} | ||
| + | |||
| + | == Headers == | ||
| + | As of '''ComputerCraft 1.63''', you can optionally set custom headers. This also means that you can override default headers such as the User-Agent. | ||
| + | {{Example | ||
| + | |desc=Sends a request to http://example.com/ with the custom headers. | ||
| + | |code=local headers = { | ||
| + | [ "User-Agent" ] = "A custom user-agent!", ''-- Overrides the default User-Agent.'' | ||
| + | [ "Hi" ] = "Hello" ''-- A non-standard custom header field.'' | ||
| + | } | ||
| + | |||
| + | [[http.get]]( "http:<nowiki/>//example.com/", headers ) | ||
| + | }} | ||
[[Category:APIs]] | [[Category:APIs]] | ||
Latest revision as of 20:35, 1 August 2015
The HTTP API must be enabled in ComputerCraft.cfg before being used. To enable it see this tutorial.
The HTTP API allows interfacing with websites and downloading from them.
 HTTP (API) | ||
|---|---|---|
| Function | Return values | Description |
| http.request(string url [, string postData [, table headers]]) | nil | Sends a HTTP request to a website, asynchronously. |
| http.get(string url [, table headers]) | table handle | Sends a HTTP GET request to a website, synchronously. |
| http.post(string url, string postData [, table headers]) | table handle | Sends a HTTP POST request to a website, synchronously. |
| http.checkURL(string url) | boolean success [, string error] | Checks if a URL is valid and is included in the HTTP whitelist. |
http.request is used to send a HTTP request that completes asynchronously and generates an event (one of http_success or http_failure). http.get and http.post execute http.request and block until the operation completes.
Handles
All three operations make use of handles, tables that contain functions to read data returned from the HTTP server. These handles act the same as the I/O handles returned by fs.open in read-only text mode, implementing the close, readLine, and readAll methods. These handles also implement the following function:
 Function h.getResponseCode | |
| Returns the numerical HTTP response code sent by the server | |
| Syntax | h.getResponseCode() |
| Returns | number HTTP response code |
| Part of | ComputerCraft |
| API | HTTP |
Headers
As of ComputerCraft 1.63, you can optionally set custom headers. This also means that you can override default headers such as the User-Agent.
 Example | |
| Sends a request to http://example.com/ with the custom headers. | |
| Code |
local headers = {
[ "User-Agent" ] = "A custom user-agent!", -- Overrides the default User-Agent.
[ "Hi" ] = "Hello" -- A non-standard custom header field.
}
http.get( "http://example.com/", headers )
|
