HttpService

Gdy ustawiono na true, pozwala skryptom wysyłać żądania do witryn za pomocą HttpService:GetAsync(), HttpService:PostAsync() i HttpService:RequestAsync().

Właściwość ta musi być przełączona za pośrednictwem interfejsu Ustawienia gry w Studio lub dla nieopublikowanych doświadczeń poprzez ustawienie tej właściwości na true za pomocą paska poleceń :

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

Ta metoda generuje losowy uniwersalnie unikalny identyfikator ( UUID ) strunę.Szesnaście oktetów UUID są reprezentowane jako 32 szesnastkowane (baza 16) cyfry, wyświetlane w pięciu grupach oddzielonych za pomocą spacji w formie 8-4-4-4-12 dla łącznie 36 znaków, na przykład 123e4567-e89b-12d3-a456-426655440000 .

Specyfikacja UUID używana jest wersja 4 (losowa), wariant 1 (DCE 1.1, ISO/IEC 11578:1996).UIDy tej wersji są najczęściej używane ze względu na swoją prostotę, ponieważ są całkowicie losowo generowane.Zauważ, że ta wersja nie ma pewnych funkcji, które mają inne wersje UUID, takich jak zakodowane znaczniki czasu, adresy MAC lub sortowanie w oparciu o czas, takie jak UUIDv7 lub ULID.

Istnieje ponad 5,3×10 ³⁶ unikalnych UUIDów v4, w których prawdopodobieństwo znalezienia powtórzenia w ciągu 103 bilionów UUIDów wynosi jedno na miliard.

Parametr wrapInCurlyBraces określa, czy zwrotiona struna jest owinięta w klamki ( {} ). Na przykład:

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

Parametry

Zwroty

local HttpService = game:GetService("HttpService")

local result = HttpService:GenerateGUID(true)

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

Ta metoda zwraca wartość dodaną wcześniej do sklepu z sekretami dla doświadczenia.Sekretna zawartość nie jest drukowana i niedostępna, gdy doświadczenie uruchamiane jest lokalnie.

Zwrócony Secret może zostać przekształcony za pomocą wbudowanych metod, takich jak Secret:AddPrefix(). Oczekuje się, że zostanie wysłany jako część żądania HTTP.

Dla więcej informacji, zobacz przewodnik użytkowania.

Parametry

Zwroty

Ta metoda przekształca obiekt JSON lub tablicę w Luau tablicę z następującymi cechami:

• Klucze tabeli to struny lub liczby, ale nie oba. Jeśli obiekt JSON zawiera oba, klucze strun są ignorowane.
• Pusty obiekt JSON generuje pustą tabelę Luau ( {} ).
• Jeśli ciąg input nie jest ważnym obiektem JSON, metoda ta wyśle błąd.

Aby zakodować tablicę Luau w obiekt JSON, użyj metody HttpService:JSONEncode().

Ta metoda może być używana niezależnie od tego, czy włączone są żądania HTTP.

Parametry

Zwroty

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

Ta metoda przekształca tabelę Luau w obiekt lub array JSON na podstawie następujących wytycznych:

• Klucze tabeli muszą być albo ciągami albo liczbami. Jeśli tabela zawiera oba, priorytet ma arkusz (ignorowane są klucze ciągów).

• Pusty stół Luau ( {} ) generuje pustą listę JSON.

• Wartość nil nigdy nie jest generowana.

• Referencje cyklicznych tabel powodują błąd.

  Ta metoda pozwala na wartości takie jak inf i nan, które nie są ważne JSON.Może to powodować problemy, jeśli chcesz używać wygenerowanego JSON gdzie indziej.

Aby odwrócić proces kodowania i zdekodować obiekt JSON, użyj metody HttpService:JSONDecode().

Ta metoda może być używana niezależnie od tego, czy włączone są żądania HTTP.

Parametry

Zwroty

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)

Ta metoda koduje procentowo daną strunę tak, aby zarezerwowane znaki zostały poprawnie zakodowane za pomocą % i dwóch znaków dwunastkowych.

Jest to przydatne podczas formatowania URL-ów do użytku z HttpService:GetAsync() / HttpService:PostAsync() lub POST danymi typu mediów application/x-www-form-urlencoded ( Enum.HttpContentType.ApplicationUrlEncoded ).

Na przykład, gdy zakodujesz URL https://www.roblox.com/discover#/, metoda ta zwraca https%3A%2F%2Fwww%2Eroblox%2Ecom%2Fdiscover%23%2F.

Parametry

Zwroty

local HttpService = game:GetService("HttpService")

local content = "Je suis allé au cinéma." -- Francuski dla "poszedłem do kina"
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)

Ta metoda wysyła żądanie HTTP GET.Funkcjonuje podobnie do RequestAsync() z wyjątkiem tego, że akceptuje parametry żądania HTTP jako parametry metody zamiast jednego słownika i zwraca tylko ciało odpowiedzi HTTP.Ogólnie rzecz biorąc, ta metoda jest przydatna tylko jako skrót i RequestAsync() powinna być stosowana w większości przypadków.

Gdy true , parametr nocache zapobiega przechowywaniu wyników metody z poprzednich wezwań za pomocą tego samego url.

Parametry

Zwroty

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

Ta metoda wysyła żądanie HTTP POST.Funkcjonuje podobnie do RequestAsync() z wyjątkiem tego, że akceptuje parametry żądania HTTP jako parametry metody zamiast jednego słownika i zwraca tylko ciało odpowiedzi HTTP.Ogólnie rzecz biorąc, ta metoda jest przydatna tylko jako skrót i RequestAsync() powinna być stosowana w większości przypadków.

Kiedy true, parametr compress kontroluje, czy duże żądania będą skompresowane za pomocą gzip .

Parametry

Zwroty

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)

Ta metoda wysyła żądanie HTTP za pomocą słownika, aby określić dane żądania, takie jak docelowa URL, metoda, nagłówki i dane ciała żądania.Zwraca słownik, który opisuje otrzymane dane odpowiedzi.Opcjonalnie wniosek można skompresować za pomocą Enum.HttpCompression .

Żądaj pól słownika

<th>Typ</th>

    <th>Wymagane</th>

    <th>Opis</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Urł</code></td>

    <td>Sznurek</td>

    <td>tak</td>

    <td>Celowa URL dla tej prośby. Musi używać protokołów <code>http</code> lub <code>https</code>.</td>
  </tr>

  <tr>
    <td><code>Metoda</code></td>

    <td>Sznurek</td>

    <td>no</td>

    <td>Metoda HTTP używana przez tę prośbę, najczęściej <code>GET</code> lub <code>POST</code>.</td>
  </tr>

  <tr>
    <td><code>Tytuły</code></td>

    <td>Słownik</td>

    <td>no</td>

    <td>Słownik nagłówków, które mają być używane z tym żądaniem. Większość nagłówków HTTP jest tutaj akceptowana, ale nie wszystkie.</td>
  </tr>

  <tr>
    <td><code>Ciało</code></td>

    <td>Sznurek</td>

    <td>no</td>

    <td>Ciało żądania.Może to być dowolna ciąg znaków, w tym dane binarne.Musi być wykluczony przy użyciu metod <code>ZDOBĄDŹ</code> lub <code>GŁOWA</code> HTTP.Może być konieczne określenie nagłówka <code>Typ treści</code> podczas wysyłania JSON lub innych formatów.</td>
  </tr>

  <tr>
    <td><code>Zmniejsz</code></td>

    <td><code>Enum.HttpKompresja</code></td>

    <td>no</td>

    <td>Opcjonalne pole kompresji, które skompresuje dane w żądaniu.Wartość może być <code>Enum.HttpCompression.None</code> lub <code>Enum.HttpCompression.Gzip</code>.</td>
  </tr>
</tbody>

Wspierane metody HTTP

Metody żądań HTTP określają cel żądania i to, co oczekuje się, jeśli żądanie zostanie pomyślnie zrealizowane.Na przykład, metoda żądania GET informuje serwer na żądanym adresie, że zasób jest żądany, a jeśli się powiedzie, zasób na tym adresie zostanie zwrócony.Podobnie metoda żądania HEAD robi to samo, z wyjątkiem tego, że serwer wie, aby zwrócić odpowiedź bez elementu Body.

<th>Opis</th>

    <th>Bezpieczny</th>
  </tr>
</thead>

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

    <td>Metoda <code>ZDOBĄDŹ</code> wymaga zasobu na określonym adresie. Nie wspiera użycia parametru <code>Ciało</code>.</td>

    <td>Tak</td>
  </tr>

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

    <td>Metoda <code>GŁOWA</code> wymaga odpowiedzi identycznej do wniosku <code>ZDOBĄDŹ</code>, ale bez ciała odpowiedzi.Nie wspiera użycia parametru <code>Ciało</code>.</td>

    <td>Tak</td>
  </tr>

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

    <td>Metoda <code>POST</code> przesyła dane <code>ciała</code> dostarczone do wskazanego adresu.</td>

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

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

    <td>Metoda <code>PUT</code> zastępuje wszystkie obecne iteracje zasobu określonego w danych <code>Body</code> dostarczonych.</td>

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

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

    <td>Metoda <code>Usuń</code> usuwa zasób określony w danych <code>Ciało</code> dostarczonych na żądany adres.</td>

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

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

    <td>Metoda <code>OPCJE</code> żąda dozwolonych opcji komunikacji dla podanego adresu.</td>

    <td>Tak</td>
  </tr>

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

    <td>Metoda <code>ŚLAD</code> wykonuje test pętli wiadomości wzdłuż ścieżki do zasobu określonego w danych <code>Ciało</code> dostarczonych.</td>

    <td>Tak</td>
  </tr>

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

    <td>Metoda <code>PATCH</code> stosuje częściowe zmiany do zasobu określonego w dostarczonych danych <code>Body</code> na żądanym adresie.</td>

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

nagłówki HTTP

W słowniku żądań możesz określić niestandardowe nagłówki HTTP do użycia w żądaniu.Jednak niektóre nagłówki nie mogą być określone.Na przykład, Content-Length jest określony z ciała żądania.User-Agent i Roblox-Id są zamknięte przez Roblox.Inne nagłówki, takie jak Accept lub Cache-Control używają domyślnych wartości, ale mogą zostać anulowane.Częściej może się zdarzyć, że niektóre interfejsy API REST mogą wymagać określenia kluczy API lub innej autoryzacji usług w nagłówkach żądań.

Metoda RequestAsync() nie wykrywa formatu treści ciała.Wiele serwerów internetowych wymaga ustawienia nagłówka Content-Type odpowiednio przy wysyłaniu pewnych formatów.Inne metody korzystają z enum; dla tej metody ustaw należycie nagłowiek : , , > lub są wartościami nagłówka zastąpienia dla odpowiednich wartości enum.

Pola słownika odpowiedzi

RequestAsync() zwraca słownik zawierający następujące pola:

<th>Typ</th>

    <th>Opis</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td><code>Pomyślny</code></td>

    <td>Booleanowy</td>

    <td>Status sukcesu żądania. Jest to prawda, jeśli i tylko jeśli <code>StatusCode</code> znajduje się w przedziale <code>200</code> - <code>299</code>.</td>
  </tr>

  <tr>
    <td><code>Kod stanu</code></td>

    <td>Liczba całkowita</td>

    <td>Kod odpowiedzi HTTP identyfikujący stan odpowiedzi.</td>
  </tr>

  <tr>
    <td><code>Message statusowy</code></td>

    <td>Sznurek</td>

    <td>Wiadomość o statusie, która została odesłana z powrotem.</td>
  </tr>

  <tr>
    <td><code>Tytuły</code></td>

    <td>Słownik</td>

    <td>Słownik nagłówków, które zostały ustawione w tej odpowiedzi.</td>
  </tr>

  <tr>
    <td><code>Ciało</code></td>

    <td />

    <td>Ciało żądania (treść) otrzymane w odpowiedzi.</td>
  </tr>
</tbody>

Przypadki błędów

RequestAsync() wywołuje błąd, jeśli czas odpowiedzi wygasa lub jeśli serwer docelowy odrzuca żądanie.Jeśli usługa webowa zostanie wyłączona z jakiegoś powodu, może to spowodować, że skrypty korzystające z tej metody przestają działać w ogóle.Często dobrym pomysłem jest owinięcie wezwań do tej metody w pcall() i łagodne radzenie sobie z przypadkami awarii, jeśli wymagane informacje nie są dostępne.

Ograniczenia

Obecna ograniczenie wysyłania i odbierania żądań HTTP wynosi 500 żądań na minutę. Żądania powyżej tego progu nie powiodą się.

Parametry

Zwroty

-- 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("Status code:", response.StatusCode, response.StatusMessage)
		print("Response body:\n", response.Body)
		print("Response headers:\n", HttpService:JSONEncode(response.Headers))
	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