ZEPETO.Multiplay.HttpService

12 min

Type	Description
HttpContentType	Énumération de constantes spécifiant le Content-Type HTTP.
HttpBodyType	Alias de type pour le contenu du corps HTTP, qui peut être du texte brut ou un objet clé-valeur.
HttpHeader	Alias de type pour les en-têtes HTTP, représentant un objet clé-valeur.
HttpErrorType	Énumération de constantes spécifiant les raisons d'échec des requêtes HTTP.
HttpError	Représente une erreur survenue lors d'une requête HTTP.
HttpResponse	Représente une réponse HTTP.
HttpService	HttpService fournit une API permettant d'établir des connexions HTTP avec des services web externes et d'effectuer des requêtes. - Veillez à utiliser le protocole HTTPS ; le protocole HTTP n'est pris en charge que dans l'environnement de développement. - Les requêtes sont limitées aux ports 80 et 443. - La taille maximale des corps de requête et de réponse est de 16 Ko. - Limitez le nombre de requêtes à moins de 500 par minute afin d'éviter d'éventuelles restrictions du service World dues à un nombre excessif de requêtes. - Les requêtes échouent si les services web externes ne répondent pas dans un délai de 5 secondes. - Assurez-vous que le Content-Type des en-têtes de réponse correspond aux valeurs définies dans l'énumération HttpContentType afin d'éviter les échecs de requête. - Les requêtes web pouvant échouer pour diverses raisons, il est recommandé d'écrire du code défensif.

HttpContentType

enum

Énumération de constantes spécifiant le Content-Type HTTP.

Nom	Valeur	Description
ApplicationJson	"application/json"	Représente le type de contenu application/json.
ApplicationXml	"application/xml"	Représente le type de contenu application/xml.
ApplicationUrlEncoded	"application/x-www-form-urlencoded"	Représente le type de contenu application/x-www-form-urlencoded.
TextPlain	"text/plain"	Représente le type de contenu text/plain.
TextXml	"text/xml"	Représente le type de contenu text/xml.

HttpBodyType

delegate

Alias de type pour le contenu du corps HTTP, qui peut être du texte brut ou un objet clé-valeur.

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

HttpHeader

delegate

Alias de type pour les en-têtes HTTP, représentant un objet clé-valeur.

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

HttpErrorType

enum

Énumération de constantes spécifiant les raisons d'échec des requêtes HTTP.

Nom	Valeur	Description
ERR_ACCESS_DENIED	"ERR_ACCESS_DENIED"	Erreur : accès refusé.
ERR_LENGTH_REQUIRED	"ERR_LENGTH_REQUIRED"	Erreur : longueur requise.

HttpError

interface · extends Error

Représente une erreur survenue lors d'une requête HTTP.

Propriétés

Nom	Type	Description
message	string	Message d'erreur.
code	string	Code d'erreur défini comme une valeur de l'énumération HttpErrorType.

HttpResponse

interface

Représente une réponse HTTP.

Propriétés

Nom	Type	Description
statusCode	number	Code d'état de la réponse. En général, 200 indique une requête réussie.
statusText	string	Message d'état correspondant au code d'état. En général, « OK » indique une requête réussie.
response	string	Corps de la réponse HTTP, dont le format peut varier selon le Content-Type de la réponse. Il est recommandé d'utiliser un analyseur adapté au Content-Type reçu.

HttpService

interface

HttpService fournit une API permettant d'établir des connexions HTTP avec des services web externes et d'effectuer des requêtes.

Veillez à utiliser le protocole HTTPS ; le protocole HTTP n'est pris en charge que dans l'environnement de développement.

Les requêtes sont limitées aux ports 80 et 443.

La taille maximale des corps de requête et de réponse est de 16 Ko.

Limitez le nombre de requêtes à moins de 500 par minute afin d'éviter d'éventuelles restrictions du service World dues à un nombre excessif de requêtes.

Les requêtes échouent si les services web externes ne répondent pas dans un délai de 5 secondes.

Assurez-vous que le Content-Type des en-têtes de réponse correspond aux valeurs définies dans l'énumération HttpContentType afin d'éviter les échecs de requête.

Les requêtes web pouvant échouer pour diverses raisons, il est recommandé d'écrire du code défensif.

Méthodes

getAsync

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

Exécute une requête HTTP GET de manière asynchrone. Lève HttpError.

Paramètre	Type	Description
url	string	Adresse web à laquelle envoyer la requête.
headers (facultatif)	HttpHeader	En-têtes de la requête HTTP. (Facultatif)

Renvoie : Promise<HttpResponse> — Promise résolue avec l'objet HttpResponse à la fin de l'opération.

postAsync

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

Exécute des requêtes HTTP POST de manière asynchrone. Lève HttpError.

Paramètre	Type	Description
url	string	Adresse web à laquelle envoyer la requête.
body	HttpBodyType	Contenu du corps de la requête.
headers (facultatif)	HttpHeader	En-têtes de la requête HTTP. (Facultatif)

Renvoie : Promise<HttpResponse> — Promise résolue avec l'objet HttpResponse à la fin de l'opération.

postAsync

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

Exécute des requêtes HTTP POST de manière asynchrone. Lève HttpError. Avec cette signature, si vous ajoutez « Content-Type » aux en-têtes, il sera remplacé par la valeur spécifiée dans httpContentType.

Paramètre	Type	Description
url	string	Adresse web à laquelle envoyer la requête.
body	HttpBodyType	Contenu du corps de la requête.
httpContentType	HttpContentType	Spécifie l'en-tête Content-Type de la requête.
headers (facultatif)	HttpHeader	En-têtes de la requête HTTP. (Facultatif)

Renvoie : Promise<HttpResponse> — Promise résolue avec l'objet HttpResponse à la fin de l'opération.