ZEPETO.Multiplay.HttpService

12 mnt

Tipe	Deskripsi
HttpContentType	Enumerasi konstanta yang menentukan Content-Type HTTP.
HttpBodyType	Alias tipe untuk konten HTTP Body, yang dapat berupa teks biasa atau objek key-value.
HttpHeader	Alias tipe untuk HTTP Header, yang merepresentasikan objek key-value.
HttpErrorType	Enumerasi konstanta yang menentukan penyebab kegagalan permintaan HTTP.
HttpError	Merepresentasikan error yang terjadi selama permintaan HTTP.
HttpResponse	Merepresentasikan HTTP Response.
HttpService	HttpService menyediakan API untuk membangun koneksi HTTP dengan layanan web eksternal dan mengirim permintaan. - Pastikan menggunakan protokol HTTPS; HTTP hanya didukung di lingkungan pengembangan. - Permintaan dibatasi pada port 80 dan 443. - Ukuran maksimum body permintaan dan respons adalah 16KB. - Jaga jumlah permintaan tetap di bawah 500 per menit untuk menghindari kemungkinan pembatasan pada layanan World akibat permintaan yang berlebihan. - Permintaan akan gagal jika layanan web eksternal tidak merespons dalam 5 detik. - Pastikan Content-Type pada header respons sesuai dengan nilai yang didefinisikan pada enum HttpContentType untuk mencegah kegagalan permintaan. - Karena permintaan web dapat gagal karena berbagai alasan, disarankan untuk menulis kode secara defensif.

HttpContentType

enum

Enumerasi konstanta yang menentukan Content-Type HTTP.

Nama	Nilai	Deskripsi
ApplicationJson	"application/json"	Merepresentasikan content type application/json.
ApplicationXml	"application/xml"	Merepresentasikan content type application/xml.
ApplicationUrlEncoded	"application/x-www-form-urlencoded"	Merepresentasikan content type application/x-www-form-urlencoded.
TextPlain	"text/plain"	Merepresentasikan content type text/plain.
TextXml	"text/xml"	Merepresentasikan content type text/xml.

HttpBodyType

delegate

Alias tipe untuk konten HTTP Body, yang dapat berupa teks biasa atau objek key-value.

string | { [key: string]: any; }

HttpHeader

delegate

Alias tipe untuk HTTP Header, yang merepresentasikan objek key-value.

{ [key: string]: string | number; }

HttpErrorType

enum

Enumerasi konstanta yang menentukan penyebab kegagalan permintaan HTTP.

Nama	Nilai	Deskripsi
ERR_ACCESS_DENIED	"ERR_ACCESS_DENIED"	Error: Akses ditolak.
ERR_LENGTH_REQUIRED	"ERR_LENGTH_REQUIRED"	Error: Panjang diperlukan.

HttpError

interface · extends Error

Merepresentasikan error yang terjadi selama permintaan HTTP.

Properti

Nama	Tipe	Deskripsi
message	string	Pesan error.
code	string	Kode error yang didefinisikan sebagai nilai dari enum HttpErrorType.

HttpResponse

interface

Merepresentasikan HTTP Response.

Properti

Nama	Tipe	Deskripsi
statusCode	number	Kode status dari respons. Umumnya, 200 menandakan permintaan berhasil.
statusText	string	Pesan status yang sesuai dengan kode status. Umumnya, "OK" menandakan permintaan berhasil.
response	string	Body dari respons HTTP, yang formatnya dapat berbeda-beda tergantung Content-Type respons. Disarankan menggunakan parser yang sesuai dengan Content-Type yang diterima.

HttpService

interface

HttpService menyediakan API untuk membangun koneksi HTTP dengan layanan web eksternal dan mengirim permintaan.

Pastikan menggunakan protokol HTTPS; HTTP hanya didukung di lingkungan pengembangan.

Permintaan dibatasi pada port 80 dan 443.

Ukuran maksimum body permintaan dan respons adalah 16KB.

Jaga jumlah permintaan tetap di bawah 500 per menit untuk menghindari kemungkinan pembatasan pada layanan World akibat permintaan yang berlebihan.

Permintaan akan gagal jika layanan web eksternal tidak merespons dalam 5 detik.

Pastikan Content-Type pada header respons sesuai dengan nilai yang didefinisikan pada enum HttpContentType untuk mencegah kegagalan permintaan.

Karena permintaan web dapat gagal karena berbagai alasan, disarankan untuk menulis kode secara defensif.

Metode

getAsync

getAsync(url: string, headers?: HttpHeader) → Promise<HttpResponse>

Menjalankan permintaan HTTP GET secara asinkron. Melempar HttpError.

Parameter	Tipe	Deskripsi
url	string	Alamat web tujuan pengiriman permintaan.
headers (opsional)	HttpHeader	Header permintaan HTTP. (Opsional)

Mengembalikan: Promise<HttpResponse> — Promise yang selesai dengan objek HttpResponse setelah proses berakhir.

postAsync

postAsync(url: string, body: HttpBodyType, headers?: HttpHeader) → Promise<HttpResponse>

Menjalankan permintaan HTTP POST secara asinkron. Melempar HttpError.

Parameter	Tipe	Deskripsi
url	string	Alamat web tujuan pengiriman permintaan.
body	HttpBodyType	Konten body permintaan.
headers (opsional)	HttpHeader	Header permintaan HTTP. (Opsional)

Mengembalikan: Promise<HttpResponse> — Promise yang selesai dengan objek HttpResponse setelah proses berakhir.

postAsync

postAsync(url: string, body: HttpBodyType, httpContentType: HttpContentType, headers?: HttpHeader) → Promise<HttpResponse>

Menjalankan permintaan HTTP POST secara asinkron. Melempar HttpError. Saat menggunakan signature ini, jika Anda menambahkan 'Content-Type' ke headers, nilainya akan ditimpa oleh nilai yang ditentukan pada httpContentType.

Parameter	Tipe	Deskripsi
url	string	Alamat web tujuan pengiriman permintaan.
body	HttpBodyType	Konten body permintaan.
httpContentType	HttpContentType	Menentukan header Content-Type pada permintaan.
headers (opsional)	HttpHeader	Header permintaan HTTP. (Opsional)

Mengembalikan: Promise<HttpResponse> — Promise yang selesai dengan objek HttpResponse setelah proses berakhir.