HttpService

Cuando se establece en true, permite que los scripts envíen solicitudes a sitios web usando HttpService:GetAsync(), HttpService:PostAsync() y HttpService:RequestAsync().

Esta propiedad debe alternarse a través de la interfaz Ajustes del juego en Studio, o para experiencias no publicadas al establecer esta propiedad a : usando la barra de comandos :

game:GetService("HttpService").HttpEnabled = true

Este método genera una cadena aleatoria universalmente única identificadora (UUID).Los dieciséis bytes de un UUID se representan como treinta y dos dígitos hexadecimales (base dieciséis) separados por guiones en la forma 8-4-4-4-12 para un total de 36 caracteres, por ejemplo 123e4567-e89b-12d3-a456-426655440000 .

La especificación UUID utilizada es Versión 4 (aleatoria), variante 1 (DCE 1.1, ISO/IEC 11578:1996).Los UUID de esta versión son los más comúnmente utilizados debido a su simplicidad, ya que se generan completamente aleatoriamente.Tenga en cuenta que esta versión no tiene ciertas características que otras versiones de UUID tienen, como marcas de tiempo codificadas, direcciones MAC o clasificación basada en el tiempo como UUIDv7 o ULID.

Hay más de 5.3×10 ³⁶ UUIDs únicos v4, en los que la probabilidad de encontrar una duplicación dentro de 103 trillones de UUIDs es de una en mil millones.

El argumento wrapInCurlyBraces determina si la cadena devuelta está envuelta en curly braces ( {} ). Por instancia:

• true : {94b717b2-d54f-4340-a504-bd809ef5bf5c}
• false : db454790-7563-44ed-ab4b-397ff5df737b

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local result = HttpService:GenerateGUID(true)

print(result) --> Example output: {4c50eba2-d2ed-4d79-bec1-02a967f49c58}

Este método devuelve un valor que se agregó anteriormente a la tienda de secretos para la experiencia.El contenido secreto no es imprimible y no está disponible cuando la experiencia se ejecuta localmente.

El devuelto Secret se puede transformar usando métodos integrados como Secret:AddPrefix(). Se espera que se envíe como parte de una solicitud HTTP.

Para obtener más información, consulte la guía de uso.

Parámetros

Devuelve

Este método transforma un objeto JSON o array en una tabla Luau con las siguientes características:

• Las claves de la tabla son cadenas o números, pero no ambas. Si un objeto JSON contiene ambas, las claves de cadena se ignoran.
• Un objeto JSON vacío genera una tabla Luau vacía ( {} ).
• Si la cadena input no es un objeto JSON válido, este método lanzará un error.

Para codificar una tabla Luau en un objeto JSON, use el método HttpService:JSONEncode().

Este método se puede usar independientemente de si las solicitudes HTTP están habilitadas.

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local jsonString = [[
{
	"message": "success",
	"info": {
		"points": 120,
		"isLeader": true,
		"user": {
			"id": 12345,
			"name": "JohnDoe"
		},
		"past_scores": [50, 42, 95],
		"best_friend": null
	}
}
]]

local data = HttpService:JSONDecode(jsonString)

if data.message == "success" then
	-- Since tab["hello"] and tab.hello are equivalent,
	-- you could also use data["info"]["points"] here:
	print("I have " .. data.info.points .. " points")
	if data.info.isLeader then
		print("I am the leader")
	end
	print("I have " .. #data.info.past_scores .. " past scores")

	print("All the information:")
	for key, value in pairs(data.info) do
		print(key, typeof(value), value)
	end
end

Este método transforma una tabla Luau en un objeto o array JSON basado en las siguientes directrices:

• Las claves de la tabla deben ser cadenas o números. Si una tabla contiene ambas, un array tiene prioridad (se ignoran las claves de cadena).

• Una tabla vacía de Luau ( {} ) genera un matriz/listaJSON vacío.

• El valor nil nunca se genera.

• Las referencias de tabla cíclicas causan un error.

  Este método permite valores como inf y nan que no son JSON válidos.Esto puede causar problemas si desea utilizar el JSON generado en otra parte.

Para revertir el proceso de codificación y decodificar un objeto JSON, utilice el método HttpService:JSONDecode().

Este método se puede usar independientemente de si las solicitudes HTTP están habilitadas.

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local tab = {
	-- Remember: these lines are equivalent
	--["message"] = "success",
	message = "success",

	info = {
		points = 123,
		isLeader = true,
		user = {
			id = 12345,
			name = "JohnDoe",
		},
		past_scores = { 50, 42, 95 },
		best_friend = nil,
	},
}

local json = HttpService:JSONEncode(tab)
print(json)

Este método codifica porcentualmente una cadena dada para que los caracteres reservados se codifiquen correctamente con % y dos caracteres hexadecimales.

Esto es útil al formatear URL para su uso con HttpService:GetAsync() / HttpService:PostAsync() o POST datos del tipo de medios application/x-www-form-urlencoded ( Enum.HttpContentType.ApplicationUrlEncoded ).

Por instancia, cuando codifiques la URL https://www.roblox.com/discover#/, este método devuelve https%3A%2F%2Fwww%2Eroblox%2Ecom%2Fdiscover%23%2F .

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local content = "Je suis allé au cinéma." -- French for "I went to the movies"
local result = HttpService:UrlEncode(content)

print(result) --> Je%20suis%20all%C3%A9%20au%20cinema%2E

local HttpService = game:GetService("HttpService")

local URL_PASTEBIN_NEW_PASTE = "https://pastebin.com/api/api_post.php"
local dataFields = {
	-- Pastebin API developer key from
	-- https://pastebin.com/api#1
	["api_dev_key"] = "FILL THIS WITH YOUR API DEVELOPER KEY",

	["api_option"] = "paste", -- keep as "paste"
	["api_paste_name"] = "HttpService:PostAsync", -- paste name
	["api_paste_code"] = "Hello, world", -- paste content
	["api_paste_format"] = "text", -- paste format
	["api_paste_expire_date"] = "10M", -- expire date
	["api_paste_private"] = "0", -- 0=public, 1=unlisted, 2=private
	["api_user_key"] = "", -- user key, if blank post as guest
}

-- The pastebin API uses a URL encoded string for post data
-- Other APIs might use JSON, XML or some other format
local data = ""
for k, v in pairs(dataFields) do
	data = data .. ("&%s=%s"):format(HttpService:UrlEncode(k), HttpService:UrlEncode(v))
end
data = data:sub(2) -- Remove the first &

-- Here's the data we're sending
print(data)

-- Make the request
local response = HttpService:PostAsync(URL_PASTEBIN_NEW_PASTE, data, Enum.HttpContentType.ApplicationUrlEncoded, false)
-- The response will be the URL to the new paste (or an error string if something was wrong)
print(response)

Este método envía una solicitud HTTP GET .Funciona de manera similar a RequestAsync() excepto que acepta parámetros de solicitud HTTP como parámetros de método en lugar de un diccionario único y devuelve solo el cuerpo de la respuesta HTTP.En general, este método solo es útil como abreviatura y RequestAsync() debe usarse en la mayoría de los casos.

Cuando true , el parámetro nocache impide que este método almacene los resultados de las llamadas anteriores con el mismo url.

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local URL_ASTROS = "http://api.open-notify.org/astros.json"

-- Make the request to our endpoint URL
local response = HttpService:GetAsync(URL_ASTROS)

-- Parse the JSON response
local data = HttpService:JSONDecode(response)

-- Information in the data table is dependent on the response JSON
if data.message == "success" then
	print("There are currently " .. data.number .. " astronauts in space:")
	for i, person in pairs(data.people) do
		print(i .. ": " .. person.name .. " is on " .. person.craft)
	end
end

local HttpService = game:GetService("HttpService")

-- Where is the International Space Station right now?
local URL_ISS = "http://api.open-notify.org/iss-now.json"

local function printISS()
	local response
	local data
	-- Use pcall in case something goes wrong
	pcall(function()
		response = HttpService:GetAsync(URL_ISS)
		data = HttpService:JSONDecode(response)
	end)
	-- Did our request fail or our JSON fail to parse?
	if not data then
		return false
	end

	-- Fully check our data for validity. This is dependent on what endpoint you're
	-- to which you're sending your requests. For this example, this endpoint is
	-- described here:  http://open-notify.org/Open-Notify-API/ISS-Location-Now/
	if data.message == "success" and data.iss_position then
		if data.iss_position.latitude and data.iss_position.longitude then
			print("The International Space Station is currently at:")
			print(data.iss_position.latitude .. ", " .. data.iss_position.longitude)
			return true
		end
	end
	return false
end

if printISS() then
	print("Success")
else
	print("Something went wrong")
end

Este método envía una solicitud HTTP POST .Funciona de manera similar a RequestAsync() excepto que acepta parámetros de solicitud HTTP como parámetros de método en lugar de un diccionario único y devuelve solo el cuerpo de la respuesta HTTP.En general, este método solo es útil como abreviatura y RequestAsync() debe usarse en la mayoría de los casos.

Cuando true, el parámetro compress controla si los grandes cuerpos de solicitud se comprimirán usando gzip .

Parámetros

Devuelve

local HttpService = game:GetService("HttpService")

local URL_PASTEBIN_NEW_PASTE = "https://pastebin.com/api/api_post.php"
local dataFields = {
	-- Pastebin API developer key from
	-- https://pastebin.com/api#1
	["api_dev_key"] = "FILL THIS WITH YOUR API DEVELOPER KEY",

	["api_option"] = "paste", -- keep as "paste"
	["api_paste_name"] = "HttpService:PostAsync", -- paste name
	["api_paste_code"] = "Hello, world", -- paste content
	["api_paste_format"] = "text", -- paste format
	["api_paste_expire_date"] = "10M", -- expire date
	["api_paste_private"] = "0", -- 0=public, 1=unlisted, 2=private
	["api_user_key"] = "", -- user key, if blank post as guest
}

-- The pastebin API uses a URL encoded string for post data
-- Other APIs might use JSON, XML or some other format
local data = ""
for k, v in pairs(dataFields) do
	data = data .. ("&%s=%s"):format(HttpService:UrlEncode(k), HttpService:UrlEncode(v))
end
data = data:sub(2) -- Remove the first &

-- Here's the data we're sending
print(data)

-- Make the request
local response = HttpService:PostAsync(URL_PASTEBIN_NEW_PASTE, data, Enum.HttpContentType.ApplicationUrlEncoded, false)
-- The response will be the URL to the new paste (or an error string if something was wrong)
print(response)

Este método envía una solicitud HTTP usando un diccionario para especificar los datos de la solicitud, como la URL objetivo, el método, las cabeceras y los datos del cuerpo de la solicitud.Devuelve un diccionario que describe los datos de respuesta recibidos.Opcionalmente, la solicitud se puede comprimir usando Enum.HttpCompression .

Solicitar campos de diccionario

<th>Tipo</th>

    <th>Requerido</th>

    <th>Descripción</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Url</code></td>

    <td>Cadena</td>

    <td>sí</td>

    <td>La URL objetivo para esta solicitud. Debe usar <code>http</code> o <code>https</code> protocolos.</td>
  </tr>

  <tr>
    <td><code>Método</code></td>

    <td>Cadena</td>

    <td>no</td>

    <td>El método HTTP que se está utilizando por esta solicitud, más a menudo <code>GET</code> o <code>POST</code> .</td>
  </tr>

  <tr>
    <td><code>Títulos</code></td>

    <td>Diccionario</td>

    <td>no</td>

    <td>Un diccionario de encabezados para usar con esta solicitud. La mayoría de los encabezados HTTP se aceptan aquí, pero no todos/todas.</td>
  </tr>

  <tr>
    <td><code>Cuerpo</code></td>

    <td>Cadena</td>

    <td>no</td>

    <td>El cuerpo de la solicitud.Puede ser cualquier cadena, incluidos datos binarios.Debe excluirse al usar los métodos HTTP <code>GET</code> o <code>HEAD</code>.Puede ser necesario especificar el encabezado <code>Tipo de contenido</code> al enviar JSON u otros formatos.</td>
  </tr>

  <tr>
    <td><code>Compresión</code></td>

    <td><code>Enum.HttpComprimación</code></td>

    <td>no</td>

    <td>Un campo de compresión opcional que comprimirá los datos de la solicitud.El valor puede ser <code>Enum.HttpCompression.None</code> o <code>Enum.HttpCompression.Gzip</code>.</td>
  </tr>
</tbody>

Métodos HTTP admitidos

Los métodos de solicitud HTTP especifican el propósito de la solicitud que se realiza y lo que se espera si la solicitud tiene éxito.Por instancia, el método de solicitud GET le dice al servidor en la dirección solicitada que se está solicitando un recurso y, si tiene éxito, se devolverá el recurso en esa dirección.Del mismo modo, el método de solicitud HEAD hace lo mismo excepto que el servidor sabe devolver una respuesta sin un elemento Body.

<th>Descripción</th>

    <th>Seguro</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>OBTENER</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/GET">ⓘ</a></td>

    <td>El método <code>GET</code> solicita la recurso en la dirección especificada. No soporta el uso del parámetro <code>Cuerpo</code>.</td>

    <td>Sí</td>
  </tr>

  <tr>
    <td><code>Cabeza</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/HEAD">ⓘ</a></td>

    <td>El método <code>Cabeza</code> solicita una respuesta idéntica a una solicitud <code>GET</code> pero sin cuerpo de respuesta.No soporta el uso del parámetro <code>Cuerpo</code>.</td>

    <td>Sí</td>
  </tr>

  <tr>
    <td><code>POST</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/POST">ⓘ</a></td>

    <td>El método POST envía los datos del cuerpo suministrados a la dirección solicitada.</td>

    <td>No</td>
  </tr>

  <tr>
    <td><code>PONER</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/PUT">ⓘ</a></td>

    <td>El método PUT reemplaza todas las iteraciones actuales del recurso especificado dentro de los datos de cuerpo suministrados.</td>

    <td>No</td>
  </tr>

  <tr>
    <td><code>ELIMINAR</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/DELETE">ⓘ</a></td>

    <td>El método <code>ELIMINAR</code> elimina el recurso especificado en los datos de <code>Cuerpo</code> proporcionados en la dirección solicitada.</td>

    <td>No</td>
  </tr>

  <tr>
    <td><code>OPCIONES</code>    <a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/OPTIONS">ⓘ</a></td>

    <td>El método <code>OPCIONES</code> solicita las opciones de comunicación permitidas para la dirección suministrada.</td>

    <td>Sí</td>
  </tr>

  <tr>
    <td><code>RASTRO</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/TRACE">ⓘ</a></td>

    <td>El método <code>RASTRO</code> realiza una prueba de bucle de mensajes en el camino hacia el recurso especificado en los datos <code>Cuerpo</code> entregados.</td>

    <td>Sí</td>
  </tr>

  <tr>
    <td><code>PARCHE</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/PATCH">ⓘ</a></td>

    <td>El método PARCHE aplica cambios parciales a la recurso especificado en los datos del cuerpo suministrados en la dirección solicitada.</td>

    <td>No</td>
  </tr>
</tbody>

Encabezados HTTP

En el diccionario de solicitudes, puedes especificar cabeceras HTTP personalizadas para usar en la solicitud.Sin embargo, algunos encabezados no se pueden especificar.Por ejemplo, Content-Length se determina desde el cuerpo de la solicitud.User-Agent y Roblox-Id están bloqueados por Roblox.Otros encabezados como Accept o Cache-Control usan valores predeterminados, pero se pueden anular.Más comúnmente, algunas API de REST pueden requerir que las claves de API u otra autenticación de servicio se especifiquen en los encabezados de solicitud.

El método RequestAsync() no detecta el formato del contenido del cuerpo.Muchos servidores web requieren que el encabezado Content-Type se establezca apropiadamente al enviar ciertos formatos.Otros métodos de utilizan el enum; para este método, establezca el encabezado apropiadamente: , , , o son valores de cabecera de reemplazo para los respectivos valores de enum.

Campos del diccionario de respuesta

RequestAsync() devuelve un diccionario que contiene los siguientes campos:

<th>Tipo</th>

    <th>Descripción</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Éxito</code></td>

    <td>Booleana</td>

    <td>El estado de éxito de la solicitud. Esto es cierto si y solo si el <code>StatusCode</code> está dentro del rango <code>200</code> - <code>299</code>.</td>
  </tr>

  <tr>
    <td><code>Código de estado</code></td>

    <td>Entero</td>

    <td>El código de respuesta HTTP que identifica el estado de la respuesta.</td>
  </tr>

  <tr>
    <td><code>Mensaje de estado</code></td>

    <td>Cadena</td>

    <td>El mensaje de estado que se envió de volver.</td>
  </tr>

  <tr>
    <td><code>Títulos</code></td>

    <td>Diccionario</td>

    <td>Un diccionario de encabezados que se establecieron en esta respuesta.</td>
  </tr>

  <tr>
    <td><code>Cuerpo</code></td>

    <td />

    <td>El cuerpo de la solicitud (el contenido) recibido en la respuesta.</td>
  </tr>
</tbody>

Casos de error

RequestAsync() levanta un error si el tiempo de respuesta expira o si el servidor objetivo rechaza la solicitud.Si un servicio web se cae por alguna razón, puede causar que los scripts que usan este método dejen de funcionar por completo.A menudo es una buena idea envolver las llamadas a este método en pcall() y manejar con gracia los casos de fallo si la información requerida no está disponible.

Limitaciones

La limitación actual para enviar y recibir solicitudes HTTP es de 500 solicitudes por minuto.Las solicitudes por encima de este umbral fallarán.Además, se excluyen los dominios de Roblox.Esto significa que las solicitudes HTTP no se pueden enviar a ningún sitio propiedad de Roblox como www.roblox.com.

Parámetros

Devuelve

-- Remember to set enable HTTP Requests in game settings!
local HttpService = game:GetService("HttpService")

local function request()
	local response = HttpService:RequestAsync({
		Url = "http://httpbin.org/post", -- This website helps debug HTTP requests
		Method = "POST",
		Headers = {
			["Content-Type"] = "application/json", -- When sending JSON, set this!
		},
		Body = HttpService:JSONEncode({ hello = "world" }),
	})

	if response.Success then
		print("Status code:", response.StatusCode, response.StatusMessage)
		print("Response body:\n", response.Body)
	else
		print("The request failed:", response.StatusCode, response.StatusMessage)
	end
end

-- Remember to wrap the function in a 'pcall' to prevent the script from breaking if the request fails
local success, message = pcall(request)
if not success then
	print("Http Request failed:", message)
end