HttpService

Khi được đặt thành true , cho phép các tập lệnh gửi yêu cầu đến các trang web bằng cách sử dụng HttpService:GetAsync() , HttpService:PostAsync() , và HttpService:RequestAsync() .

Thuộc tính này phải được bật/tắt thông qua giao diện Cài đặt trò chơi trong Studio, hoặc cho kinh nghiệm chưa công bố bằng cách đặt thuộc tính này thành bằng Command Bar :

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

Phương pháp này tạo ra một chuỗi nhận dạng ngẫu nhiên và duy nhất toàn cầu ( UUID ) ngẫu nhiên.Sáu mươi sáu octet của một UUID được biểu diễn như 32 chữ số hexadecimal (cơ sở 16) được hiển thị trong năm nhóm được tách bởi dấu gạch ngang trong hình thức 8-4-4-4-12 với tổng cộng 36 ký tự, ví dụ 123e4567-e89b-12d3-a456-426655440000 .

Thông số UUID được sử dụng là Phiên bản 4 (ngẫu nhiên), biến thể 1 (DCE 1.1, ISO/IEC 11578:1996).UUID của phiên bản này được sử dụng phổ biến nhất do sự đơn giản của chúng, vì chúng được tạo ngẫu nhiên hoàn toàn.Lưu ý rằng phiên bản này không có các tính năng nhất định mà các phiên bản UUID khác có, chẳng hạn như dấu thời gian mã hóa, địa chỉ MAC hoặc sắp xếp theo thời gian như UUIDv7 hoặc ULID.

Có hơn 5.3×10 ³⁶ UUID v4 độc đáo, trong đó khả năng tìm thấy một phiên bản trùng lặp trong 103 triệu UUID là một trong một tỷ.

Tham số wrapInCurlyBraces xác định xem chuỗi trả về có được bọc trong dấu ngoặc kép ( {} ) hay không. Ví dụ:

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

Tham Số

Lợi Nhuận

local HttpService = game:GetService("HttpService")

local result = HttpService:GenerateGUID(true)

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

Phương pháp này trả về một giá trị đã được thêm vào cửa hàng bí mật trước đó cho trải nghiệm.Nội dung bí mật không thể in được và không có sẵn khi trải nghiệm chạy địa phương.

Các tham số trả về Secret có thể được biến đổi bằng cách sử dụng các phương pháp tích hợp sẵn như Secret:AddPrefix() . Nó được mong đợi được gửi như một phần của yêu cầu HTTP.

Để biết thêm thông tin, xem hướng dẫn sử dụng .

Tham Số

Lợi Nhuận

Phương pháp này biến một đối tượng JSON hoặc mảng thành một bảng Luau với các tính năng sau:

• Các chìa khóa của bảng là chuỗi hoặc số nhưng không cả hai. Nếu một đối tượng JSON chứa cả hai, các chìa khóa dây sẽ bị bỏ qua.
• Một đối tượng JSON trống tạo ra một bảng Luau trống ( {} ).
• Nếu chuỗi input không phải là một đối tượng JSON hợp lệ, phương pháp này sẽ ném lỗi.

Để mã hóa một bảng Luau thành một đối tượng JSON, hãy sử dụng phương pháp HttpService:JSONEncode().

Phương pháp này có thể được sử dụng bất kể liệu yêu cầu HTTP có được bật hay không.

Tham Số

Lợi Nhuận

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

Phương pháp này biến một bảng Luau thành một đối tượng JSON hoặc một mảng dựa trên các hướng dẫn sau:

• Các chìa khóa của bảng phải là chuỗi hoặc số. Nếu bảng có cả hai, một mảng được ưu tiên (chìa khóa chuỗi bị bỏ qua).

• Một bảng Luau trống ( {} ) tạo một mảng JSON trống.

• Giá trị nil không bao giờ được tạo ra.

• Tham chiếu bảng lặp gây ra một lỗi.

  Phương pháp này cho phép các giá trị như inf và nan không phải là JSON hợp lệ.Điều này có thể gây ra vấn đề nếu bạn muốn sử dụng JSON xuất ở nơi khác.

Để đảo ngược quá trình mã hóa và giải mã một đối tượng JSON, hãy sử dụng phương pháp HttpService:JSONDecode().

Phương pháp này có thể được sử dụng bất kể liệu yêu cầu HTTP có được bật hay không.

Tham Số

Lợi Nhuận

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)

Phương pháp này mã hóa phần trăm một chuỗi nhất định để các ký tự dự trữ được mã hóa đúng cách với % và hai ký tự hexadecimal.

Điều này hữu ích khi định dạng URL để sử dụng với HttpService:GetAsync() / HttpService:PostAsync() , hoặc POST dữ liệu của loại phương tiện application/x-www-form-urlencoded ( Enum.HttpContentType.ApplicationUrlEncoded ).

Ví dụ, khi bạn mã hóa URL https://www.roblox.com/discover#/, phương pháp này trả về https%3A%2F%2Fwww%2Eroblox%2Ecom%2Fdiscover%23%2F .

Tham Số

Lợi Nhuận

local HttpService = game:GetService("HttpService")

local content = "Je suis allé au cinéma." -- Tiếng Pháp cho "Tôi đã đi xem phim"
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)

Phương pháp này gửi một yêu cầu HTTP GET .Nó hoạt động tương tự như RequestAsync() ngoại trừ việc nó chấp nhận các tham số yêu cầu HTTP như tham số phương thức thay vì một từ điển duy nhất và trả về chỉ cơ thể của phản hồi HTTP.Nói chung, phương pháp này chỉ hữu ích như một tắt và RequestAsync() nên được sử dụng trong hầu hết các trường hợp.

Khi true , tham số nocache ngăn chặn phương pháp này lưu trữ kết quả lưu trữ từ các cuộc gọi trước với cùng url .

Tham Số

Lợi Nhuận

local HttpService = game:GetService("HttpService")

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

-- Gửi yêu cầu đến URL cuối cùng của chúng tôi
local response = HttpService:GetAsync(URL_ASTROS)

-- Phân tích phản hồi JSON
local data = HttpService:JSONDecode(response)

-- Thông tin trong bảng dữ liệu phụ thuộc vào phản hồi 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

Phương pháp này gửi một yêu cầu HTTP POST .Nó hoạt động tương tự như RequestAsync() ngoại trừ việc nó chấp nhận các tham số yêu cầu HTTP như tham số phương thức thay vì một từ điển duy nhất và trả về chỉ cơ thể của phản hồi HTTP.Nói chung, phương pháp này chỉ hữu ích như một tắt và RequestAsync() nên được sử dụng trong hầu hết các trường hợp.

Khi true , tham số compress kiểm soát xem các thân yêu cầu lớn có bị nén bằng gzip hay không.

Tham Số

Lợi Nhuận

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)

Phương pháp này gửi một yêu cầu HTTP bằng một từ điển để xác định dữ liệu yêu cầu, chẳng hạn như URL mục tiêu, phương pháp, tiêu đề và dữ liệu cơ thể yêu cầu.Nó trả về một từ điển mô tả dữ liệu phản hồi đã nhận.Tùy chọn, yêu cầu có thể được nén bằng cách sử dụng Enum.HttpCompression .

Yêu cầu các trường từ điển

<th>Loại</th>

    <th>Yêu cầu</th>

    <th>Mô tả</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Liên kết</code></td>

    <td>Chuỗi</td>

    <td>có</td>

    <td>URL mục tiêu cho yêu cầu này. Phải sử dụng <code>http</code> hoặc <code>https</code> giao thức.</td>
  </tr>

  <tr>
    <td><code>Phương pháp</code></td>

    <td>Chuỗi</td>

    <td>no</td>

    <td>Phương pháp HTTP được sử dụng bởi yêu cầu này, hầu hết là <code>Nhận</code> hoặc <code>Gửi</code>.</td>
  </tr>

  <tr>
    <td><code>Tiêu đề</code></td>

    <td>Từ điển</td>

    <td>no</td>

    <td>Một từ điển các tiêu đề sẽ được sử dụng với yêu cầu này. Hầu hết các tiêu đề HTTP được chấp nhận ở đây, nhưng không phải tất cả.</td>
  </tr>

  <tr>
    <td><code>Thân</code></td>

    <td>Chuỗi</td>

    <td>no</td>

    <td>Thân yêu cầu.Có thể là bất kỳ chuỗi nào, bao gồm cả dữ liệu nhị phân.Phải bị loại bỏ khi sử dụng các phương pháp <code>Nhận</code> hoặc <code>Đầu</code> HTTP GET.Có thể cần phải xác định tiêu đề <code>Loại nội dung</code> khi gửi JSON hoặc các định dạng khác khi gửi JSON.</td>
  </tr>

  <tr>
    <td><code>Ngăn xếp</code></td>

    <td><code>Enum.HttpCompression Trang chủ</code></td>

    <td>no</td>

    <td>Một trường nén tùy chọn sẽ nén dữ liệu trong yêu cầu.Giá trị có thể là <code>Enum.HttpCompression.None</code> hoặc <code>Enum.HttpCompression.Gzip</code>.</td>
  </tr>
</tbody>

Hỗ trợ các phương pháp HTTP

Các phương thức yêu cầu HTTP xác định mục đích của yêu cầu được thực hiện và những gì mong đợi nếu yêu cầu thành công.Ví dụ, phương pháp yêu cầu GET cho thấy server tại địa chỉ yêu cầu rằng một tài nguyên đang được yêu cầu và, nếu thành công, tài nguyên tại địa chỉ đó sẽ được trả lại.Tương tự, phương pháp yêu cầu HEAD như vậy cũng làm tương tự ngoại trừ máy chủ biết trả lời không có thành phần Body .

<th>Mô tả</th>

    <th>An toàn</th>
  </tr>
</thead>

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

    <td>Phương pháp <code>Nhận</code> yêu cầu tài nguyên tại địa chỉ được chỉ định. Không hỗ trợ sử dụng tham số <code>Thân</code>.</td>

    <td>Có</td>
  </tr>

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

    <td>Phương pháp <code>HEAD</code> yêu cầu một phản hồi tương tự như một yêu cầu <code>GET</code>, nhưng không có cơ thể phản hồi.Không hỗ trợ sử dụng tham số <code>Body</code>.</td>

    <td>Có</td>
  </tr>

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

    <td>Phương pháp <code>GỬI</code> đưa dữ liệu <code>Thân</code> được cung cấp đến địa chỉ yêu cầu.</td>

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

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

    <td>Phương pháp <code>PUT</code> thay thế tất cả các lần lặp hiện tại của tài nguyên được đặc trưng trong dữ liệu <code>Body</code> cung cấp.</td>

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

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

    <td>Phương pháp <code>XÓA</code> xóa tài nguyên được chỉ định trong dữ liệu <code>Thân</code> được cung cấp tại địa chỉ yêu cầu.</td>

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

  <tr>
    <td><code>TÙY CHỌN</code>    <a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/OPTIONS">ⓘ</a></td>

    <td>Phương pháp <code>OPTIONS</code> yêu cầu các tùy chọn giao tiếp được phép cho địa chỉ cung cấp.</td>

    <td>Có</td>
  </tr>

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

    <td>Phương pháp <code>TRACE</code> thực hiện kiểm tra vòng lặp lời nhắn dọc theo con đường đến tài nguyên được chỉ định trong dữ liệu <code>Thân</code> được cung cấp.</td>

    <td>Có</td>
  </tr>

  <tr>
    <td><code>BẢN CẬP NHẬT</code><a href="https://developer.mozilla.org/docs/Web/HTTP/Methods/PATCH">ⓘ</a></td>

    <td>Phương pháp <code>SỬA LỖI</code> áp dụng các thay đổi một phần cho tài nguyên được chỉ định trong dữ liệu <code>Thân</code> được cung cấp tại địa chỉ yêu cầu.</td>

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

Đầu mối HTTP

Trong từ điển yêu cầu, bạn có thể xác định các tiêu đề HTTP tùy chỉnh để sử dụng trong yêu cầu.Tuy nhiên, một số tiêu đề không thể được xác định.Ví dụ, Content-Length được xác định từ cơ thể yêu cầu.User-Agent và Roblox-Id bị khóa bởi Roblox.Các tiêu đề khác như Accept hoặc Cache-Control sử dụng các giá trị mặc định nhưng có thể bị thay thế.Phổ biến hơn, một số API REST có thể yêu cầu API key hoặc xác minh dịch vụ khác phải được định nghĩa trong tiêu đề yêu cầu.

Phương thức RequestAsync() không phát hiện định dạng nội dung thân.Nhiều máy chủ web yêu cầu tiêu đề Content-Type được đặt thích hợp khi gửi các định dạng nhất định. Các phương pháp khác của sử dụng enum ; cho phương pháp này thiết lập đầu mục thích hợp: , > , > , > hoặc > là các giá trị đầu mục thay thế cho các giá trị enum tương ứng.

Các trường từ điển phản hồi

RequestAsync() trả về một từ điển chứa các trường sau:

<th>Loại</th>

    <th>Mô tả</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Thành công</code></td>

    <td>Boolean Hoặc</td>

    <td>Tình trạng thành công của yêu cầu. Điều này là đúng nếu và chỉ nếu <code>StatusCode</code> nằm trong phạm vi <code>200</code> - <code>299</code>.</td>
  </tr>

  <tr>
    <td><code>Mã trạng thái</code></td>

    <td>Số nguyên</td>

    <td>Mã đáp lời HTTP xác định tình trạng của phản hồi.</td>
  </tr>

  <tr>
    <td><code>Tin nhắn trạng thái</code></td>

    <td>Chuỗi</td>

    <td>Tin nhắn trạng thái đã được gửi trở lại.</td>
  </tr>

  <tr>
    <td><code>Tiêu đề</code></td>

    <td>Từ điển</td>

    <td>Một từ điển các tiêu đề đã được đặt trong phản hồi này.</td>
  </tr>

  <tr>
    <td><code>Thân</code></td>

    <td />

    <td>Thân yêu cầu (nội dung) nhận được trong phản hồi.</td>
  </tr>
</tbody>

Trường hợp lỗi

RequestAsync() nâng lên một lỗi nếu thời gian phản hồi hết hạn hoặc nếu máy chủ mục tiêu từ chối yêu cầu.Nếu một dịch vụ web bị gián đoạn vì một số lý do, nó có thể gây ra các kịch bản sử dụng phương pháp này ngừng hoạt động hoàn toàn.Thường là một ý tưởng tốt để bọc các cuộc gọi đến phương pháp này trong pcall() và xử lý lỗi một cách thanh lịch nếu thông tin cần thiết không có sẵn.

Hạn chế

Giới hạn hiện tại cho việc gửi và nhận yêu cầu HTTP là 500 yêu cầu mỗi phút. Các yêu cầu vượt quá ngưỡng này sẽ thất bại.

Tham Số

Lợi Nhuận

-- 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

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

local groupId = "your_group_id"
local membershipId = "your_membership_id"
local roleId = "your_role_id"

local function request()
	local response = HttpService:RequestAsync({
		Url = `https://apis.roblox.com/cloud/v2/groups/{groupId}/memberships/{membershipId}`, -- Updates a user's group membership
		Method = "PATCH",
		Headers = {
			["Content-Type"] = "application/json", -- When sending JSON, set this!
			["x-api-key"] = HttpService:GetSecret("APIKey"), -- Set in Creator Hub
		},
		Body = HttpService:JSONEncode({ role = `groups/{groupId}/roles/{roleId}` }),
	})

	if response.Success then
		print("The response was successful:", response.StatusCode, response.StatusMessage)
	else
		print("The response returned an error:", response.StatusCode, response.StatusMessage)
	end
	print("Response body:\n", response.Body)
	print("Response headers:\n", HttpService:JSONEncode(response.Headers))
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("The Http request failed to send:", message)
end