| | |
| Nom de la propriété | Type manipulé | Effet |
|---|
| AgentUtilisateur | Chaîne de caractères | Identifie le client. Par défaut, la valeur est "PC SOFT Framework". Le contenu de la réponse peut dépendre de l'agent utilisateur (par exemple, une requête effectuée à partir d'un Mobile peut nécessiter des pages différentes d'une requête effectuée avec un navigateur PC). Dans ce cas, consultez la documentation de l'agent utilisateur pour plus de détails. |
| Authentification | Constante de type Entier | Permet de définir le mode d'authentification nécessaire pour avoir accès à certaines ressources du serveur ou du site : - auBasic : Le nom et le mot de passe sont en clair dans la requête.
- auDigest : Le nom et le mot de passe sont modifié via un hash.
- auNegotiate : Le client et le serveur échangent un certain nombre d'informations avant d'établir une connexion. Le protocole Kerberos est tout d'abord utilisé et s'il n'est pas disponible, le protocole NTLM est utilisé.
- auNTLM : Le client et le serveur échangent un certain nombre d'informations avant d'établir une connexion via le protocole NTLM (Windows uniquement).
|
| AuthToken | Variable de type AuthToken | Token d'accès à un Webservice à utiliser en cas d'authentification via le protocole OAuth 2.0. Ce token d'accès a été récupéré via la fonction AuthIdentifie. Le token d'accès est automatiquement passé au paramètre access_token directement sur l'URL. Si le paramètre doit être différent, construisez vous-même l'URL à exécuter. |
| AvancementEnvoi | Variable de type httpAvancement | Notification de l'état d'avancement de l'envoi des données POST. |
| AvancementTéléchargement | Variable de type httpAvancement | Notification de l'état d'avancement de la réception des données. |
| CertificatClient | Chaîne de caractères ou buffer | Correspond : - à une chaîne de caractères contenant un chemin d'accès au fichier .p12 contenant le certificat à joindre à la requête. Le chargement du certificat se fera automatiquement en prenant :
- le certificat présent dans la bibliothèque de l'exécutable (s'il a été intégré à l'application),
- le certificat présent à l'emplacement spécifié sur disque (si le certificat n'a pas été intégré dans la bibliothèque de l'exécutable).
- Ã un buffer contenant le certificat (utilisation de la fonction fChargeBuffer).
Si cette propriété correspond à une chaîne vide (""), le certificat par défaut est réinitialisée à "<Aucun>". |
| CipherChoisi | Chaîne de caractères | Nom du cipher choisi pour la requête sécurisée. Cette propriété est disponible uniquement en lecture. |
| ContentType | Chaîne de caractères | Type du contenu du message à envoyer au serveur. Cette propriété est prise en compte uniquement si la méthode d'envoi (propriété Méthode) le permet. Par défaut, le type du message correspond à : "application/x-www-form-urlencoded". Il est cependant possible de mettre n'importe quelle valeur, par exemple : "text/xml", "application/javascript", "application/json", "application/xml", "image/jpeg", ... Pour envoyer des données brutes, qui seront lues en une seule fois par le serveur d'application WEBDEV, utilisez les types : - "application/octet-stream".
- "text/xml".
|
| Contenu | Buffer | Message à envoyer au serveur. Cette propriété est prise en compte uniquement si la méthode d'envoi (propriété Méthode) le permet. Le message à envoyer doit respecter le protocole HTTP utilisé. Par défaut, si cette propriété est précisée et non vide, la méthode utilisée est une requête POST sinon c'est une requête GET. |
| Booléen | Indique si la propriété Contenu doit correspondre au contenu brute :- Vrai : la propriété Contenu correspond à un buffer. Aucune modification n'est effectuée.
- Faux (Valeur par défaut) : le contenu est modifié par le navigateur. En particulier, le texte UTF-8 est automatiquement décodé. la propriété Contenu retourne le résultat sous forme d'une chaîne.
|
| DébitEnvoiMax | Entier | Vitesse maximale à utiliser pour l'envoi des données, exprimée en kilo-octets par seconde. Cette vitesse est donnée à titre indicatif.
0 (valeur par défaut) signifie que cette vitesse n'est pas limitée. |
| DébitTéléchargementMax | Entier | Vitesse maximale à utiliser pour la réception des données, exprimée en kilo-octets par seconde. Cette vitesse est donnée à titre indicatif.
0 (valeur par défaut) signifie que cette vitesse n'est pas limitée. |
| Destination | Chaîne de caractères | Chemin complet du fichier de sauvegarde du résultat de la requête. |
| DuréeNonRéponse | Entier | Temps maximum d'attente de la réponse (exprimé en millisecondes). Cette propriété peut correspondre à : - un entier correspondant au nombre de millisecondes,
- une variable de type Durée,
- l'indication directe de la durée (par exemple 1 s ou 10 ms).
Par défaut, cette propriété vaut 20 secondes. Remarque : Le timeout défini avec la fonction HTTPTimeOut n'a pas d'influence sur cette propriété. |
| Entête | Tableau associatif de chaînes de caractères | Ensemble clé/valeur des entêtes à envoyer.Exemple d'utilisation de cette propriété :
cMaRequête est un httpRequête
cMaRequête.Entête["Authorization"] = ...
" WSSE profile=""UsernameToken"""
cMaRequête.Entête["X-WSSE"] = ...
"UsernameToken Username=blahblah "
cMaRequête.Entête["Cache-Control"] = " no-cache"
Changement de comportement à partir de la version 29 Update 3 : - Avant la version 29 Update 3, les entêtes vides ne sont pas transmis.
- A partir de la version 29 Update 3, les entêtes vides sont transmis. Exemple :
req est un httpRequête
req..Entête["Vide"] = ""
req.Envoie()
|
| IgnoreErreur | Constante de type Entier | Spécifie les erreurs ignorées. Correspond à une constante ou une combinaison de constantes : - httpIgnoreCertificatInvalide : Le certificat est ignoré.
- httpIgnoreNomCertificatInvalide : Le nom du site figurant dans le certificat est ignoré.
- httpIgnoreCertificatExpiré : La date du certificat est ignorée.
- httpIgnoreRedirection : La redirection vers une page est ignorée.
- httpIgnoreRenvoiHTTP : Le renvoi vers un serveur non sécurisé est autorisé.
- httpIgnoreRenvoiHTTPS : Le renvoi vers un serveur sécurisé est autorisé.
|
| Méthode | Constante de type Entier | Méthode HTTP utilisée : - httpCopy : Méthode COPY (valeur 7).
- httpDelete : Méthode DELETE (valeur 4).
- httpGet : Méthode GET (valeur 1).
- httpHead : Méthode HEAD (valeur 5).
- httpLock : Méthode LOCK (valeur 12) (protocole WebDAV).
- httpMkCol : Méthode MKCOL (valeur 10) (protocole WebDAV).
- httpMove : Méthode MOVE (valeur 11) (protocole WebDAV).
- httpPatch : Méthode PATCH (valeur 6).
- httpPost : Méthode POST (valeur 2).
- httpPropFind : Méthode PROPFIND (valeur 8) (protocole WebDAV).
- httpPropPatch : Méthode PROPPATCH (valeur 9) (protocole WebDAV).
- httpPut : Méthode PUT (valeur 3).
- httpUnlock : Méthode UNLOCK (valeur 13) (protocole WebDAV).
Par défaut, si la propriété Contenu est non vide, la méthode httpPost est utilisée. Dans le cas contraire, la méthode httpGet est utilisée. |
| MotDePasse | Chaîne de caractères | Mot de passe associé au nom d'utilisateur (chaîne vide par défaut). Permet d'accéder à une page avec une URL protégée. Attention : Le mot de passe est transmis en clair sur Internet. Remarque : En renseignant les propriétés NomUtilisateur et MotDePasse, le "Authorization:Basic" correspondant est automatiquement généré dans l'entête de la requête. |
| MotDePasseCertificatClient | Chaîne de caractères | Mot de passe associé au certificat client (chaîne vide par défaut). |
| ProcédureTrace | Procédure | Nom de la procédure WLangage permettant de connaître les entêtes et les données envoyées. Cette procédure est de la forme :
PROCÉDURE <Nom procédure>(<TypeInfo> est entier,
<Data> est un Buffer) - <TypeInfo> est une constante de type Entier correspondant au type de données tracées :
- httpTraceDonnéeEnvoyée : Données envoyées.
- httpTraceDonnéeRecue : Données reçues.
- httpTraceEntêteEnvoyé : Entête envoyé.
- httpTraceEntêteRecu : Entête reçu.
- httpTraceInfo : Informations détaillées sur l’exécution de la requête (erreur bas niveau de cURL/OpenSSL, étape en cours, avertissements, etc.).
- <Data> est un buffer contenant les informations.
Exemple de procédure : PROCÉDURE ProcTrace(nTypeInfo est entier, ...
bufByData est un Buffer)
SELON nTypeInfo
CAS httpTraceEntêteEnvoyé:
Trace("Entete : ", ...
UTF8VersChaîne(bufByData))
CAS httpTraceDonnéeEnvoyée:
Trace("Donnees : ", ...
bufByData)
CAS httpTraceEntêteRecu:
Trace("Entête reçu : ", ...
UTF8VersChaîne(bufByData))
CAS httpTraceDonnéeRecue:
Trace("Données reçues : ", ...
bufByData)
FIN
|
| TimeoutConnexion | Entier | Temps maximal d'attente pour la connexion exprimé en millisecondes (par défaut 20 secondes, soit 20000 millisecondes). Cette propriété peut correspondre à : - un entier correspondant au nombre de millisecondes,
- une variable de type Durée,
- l'indication directe de la durée (par exemple '20s' ou '20000ms').
Si à la fin de ce délai, la connexion n'a pas pu s'effectuer, il y a échec de la connexion (la fonction RESTEnvoie par exemple renverra une erreur, contenue dans la variable résultat de type restRéponse). |
| URL | Chaîne de caractères | Adresse du serveur à contacter sous forme d'adresse URL. Cette URL peut contenir : - le numéro de port pour la connexion sur le serveur.
La valeur par défaut est 80 en HTTP (correspond à un serveur de pages Web) et 443 en HTTPS. Pour spécifier un numéro de port, utilisez le format : "<URL du serveur>:<N° du port>". Par exemple : "http://www.pcsoft.fr:80". - des paramètres supplémentaires. Ces paramètres peuvent permettre d'effectuer une recherche ou de remplir un formulaire. Par exemple, pour rechercher "pcsoft" sur "http://www.google.fr", l'URL à contacter sera : "http://www.google.fr/search?q=pcsoft".
Remarques : - Pour spécifier à la fois le numéro de port et des paramètres supplémentaires, utilisez le format : "<URL du serveur>:<N° du port>/<Paramètres supplémentaires>".
- Pour réaliser une transaction sécurisée, l'URL doit commencer par la chaîne "https://". Dans ce cas, le mode de gestion des requêtes est toujours effectué par Internet Explorer (pour plus de détails, consultez la fonction HTTPParamètre).
|
| Utilisateur | Chaîne de caractères | Nom permettant d'accéder à une page avec une URL protégée (chaîne vide par défaut). Ce nom permet d'identifier l'utilisateur. Remarque : En renseignant les propriétés NomUtilisateur et MotDePasse, le "Authorization:Basic" correspondant est automatiquement généré dans l'entête de la requête. |
| VersionHTTP | Constante de type Entier | Version du protocole HTTP utilisée par le serveur : - httpVersion2 : Protocole HTTP version 2.0. Si le serveur ne gère pas cette version, une version plus ancienne est utilisée.
- httpVersion2Uniquement : Protocole HTTP version 2.0 forcée : si le serveur ne gère pas cette version, une erreur fatale est affichée.
- httpVersion1_1 : Protocole HTTP version 1.1.
- httpVersion1_0 : Protocole HTTP Version 1.0.
- httpVersionDéfaut : Protocole HTTP Version 1.0.
|
| VersionSSL | Constante de type Entier | Version SSL minimum et maximum à utiliser. Pour limiter par exemple à TLS entre 1.1 et 1.3, il suffit d'indiquer la combinaison de constantes ProtocoleTLS1_1 + ProtocoleTLS1_3 Les constantes utilisables sont les suivantes : - ProtocoleDéfaut : Protocole par défaut. C'est la version la plus élevée qui est proposée (ou une version inférieure si le serveur ne supporte pas ce protocole).
- ProtocoleTLS1 : Protocole TLS1.
- ProtocoleTLS1_1 : Protocole TLS1.1.
- ProtocoleTLS1_2 : Protocole TLS1.2.
- ProtocoleTLS1_3 : Protocole TLS1.3.
|
| VersionSSLChoisie | Constante de type Entier | Version SSL choisie pour une requête sécurisée : - ProtocoleDéfaut : Protocole par défaut (TLS 1.2).
- ProtocoleTLS1 : Protocole TLS1.
- ProtocoleTLS1_1 : Protocole TLS1.1.
- ProtocoleTLS1_2 : Protocole TLS1.2.
- ProtocoleTLS1_3 : Protocole TLS1.3.
Cette propriété est disponible uniquement en lecture. |