 | TABLE DES MATIÈRES Portails : portal/getPortails : portal/getlist Portails : portal/create Portails : portal/edit Description des codes d’erreurs de portail |
PORTAILS
Les « portails » sont les points d'entrée de votre environnement : ils déterminent l'image de marque, la langue, le catalogue et les paramètres de création de compte présentés aux utilisateurs. Un portail dans l'API est nommé « portal ». |  |
Portails : portal/get
https://www.domaine.com/lmsapi/portal/get
 | Retourne l’ensemble des informations relatives à un portail de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations pour un portail :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du portail. (Type string) |
Réponse
Exemple de contenu d'appel de réponse des informations pour un portail :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"title": {
"texts": [{
"text": "MonPortail",
"languageId": 1
}
]
},
"subTitle": {
"texts": [{
"text": "Mon sous-titre",
"languageId": 1
}
]
},
"description": {
"texts": [{
"text": "Ma description",
"languageId": 1
}
]
},
"newAccountButtonLabel": {
"texts": [{
"text": "Inscrivez-vous!",
"languageId": 1
}
]
},
"newAccountDescription": {
"texts": [{
"text": "Inscrivez-vous dès maintenant en remplissant le formulaire suivant : ",
"languageId": 1
}
]
},
"branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"coverID": 3,
"allowNewAccount": false,
"creationDate": "2018-01-01",
"url": "siteUrl/monUrl",
"name": "nom de portail",
"dns": "mondns",
"language": 1,
"newUserLanguage": 1,
"hasCustomLogo": false,
"lastModificationDate": "2018-01-02",
"defaultBranchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"isDefaultPortal": false,
"displayType": 1,
"createdByUserID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"keywords": "mot1,mot2,mot3",
"seoDescription": "une description",
"googleAnalyticsKey": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"providerFilter": false,
"languageFilter": false,
"isUsingCustomSupportInfo": true,
"newAccountUrl": "",
"isEmailValidatedByCode": true
}Description des champs
Nom | Commentaires/description |
id | Identifiant unique du portail (Type string) Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition. |
title text languageId | text : Titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
subTitle text languageId | text : Sous-titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
description text languageId | text : Description du portail telle que vue par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
newAccountButtonLabel text languageId | text : Libellé sur le bouton de création de compte. (Type string) languageId : langue d'affichage :
(Type Number) |
newAccountDescription text languageId | text : Libellé affiché avant le formulaire de création de compte. (Type string) languageId : langue d'affichage :
(Type Number) |
name | Nom du portail tel que vu par l’administration. (Type string) Ce paramètre est obligatoire en mode création. |
coverID | Identifiant pour le visuel du portail. (Type number) |
allowNewAccount | Autorisation des nouveaux utilisateurs à se créer un compte (Type Boolean) |
defaultBranchID | Branche par défaut aux nouveaux comptes créés. (Type string) allowNewAccount doit être à true pour appliquer ce champ. |
branchID | Branche du portail. (Type string) Ce paramètre est obligatoire en mode création. |
creationDate | Date de création du portail Ne peut être modifié. Disponible sur get et getlist. |
url | Url du portail. (Type string) L’url du site du client sera concaténée à la sauvegarde. Ce paramètre est obligatoire en mode création. |
dns | Dns du portail. (Type string) Passer vide pour enlever. |
language | Langue d’affichage du portail
(Type Number) |
newUserLanguage | Langue par défaut des nouveaux utilisateurs
(Type Number) |
hasCustomLogo | Indique si un logo personnalisé a été attribué au portail. |
lastModificationDate | Date de la dernière modification du portail Ne peut être modifié. Disponible sur get et getlist. |
isDefaultPortal | Indique si le portail est celui par défaut. (Type boolean) Ne peut être modifié. Disponible sur get et getlist. |
displayType | Type d’affichage dans les catalogues.
(Type Number) |
createdByUserID | Identifiant de l’utilisateur qui a créé le portail (Type string) Ne peut être modifié. Disponible sur get et getlist. -1 indique une création par l’API. |
keywords | Mots-clés pour le référencement (Type string) Les mots doivent être séparés par des virgules. Passer vide pour enlever. |
seoDescription | Description pour le référencement (Type string) Passer vide pour enlever. |
googleAnalyticsKey | Clé pour Google Analytics (Type string) Passer vide pour enlever. |
providerFilter | Désigne si les onglets de fournisseur sont utilisés pour le tri dans les catalogues. (Type boolean) |
languageFilter | Désigne si le filtre de langue est utilisé pour le tri dans les catalogues. (Type boolean) |
isUsingCustomSupportInfo | Indique si le portail utilise des informations de contact personnalisées pour l’assistance technique (Type boolean) |
newAccountUrl | Url du bouton de création de compte pour le portail. (Type string) |
isEmailValidatedByCode | Indique si le portail force la validation de courriel par code envoyé au courriel (Type boolean) |
Portails : portal/getlist
https://www.domaine.com/lmsapi/portal/getlist
| Retourne la liste de l’ensemble des portails de votre environnement. |
Requête
Exemple de contenu d'appel de requête de la liste des portails :
{
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| La méthode ne requiert aucun paramètre. |
Réponse
Exemple de contenu d'appel de réponse des informations pour la liste des portails :
[
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"title": {
"texts": [{
"text": "MonPortail",
"languageId": 1
}
]
},
"subTitle": {
"texts": [{
"text": "Mon sous-titre",
"languageId": 1
}
]
},
"description": {
"texts": [{
"text": "Ma description",
"languageId": 1
}
]
},
"newAccountButtonLabel": {
"texts": [{
"text": "Inscrivez-vous!",
"languageId": 1
}
]
},
"newAccountDescription": {
"texts": [{
"text": "Inscrivez-vous dès maintenant en remplissant le formulaire suivant : ",
"languageId": 1
}
]
},
"branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"coverID": 3,
"allowNewAccount": false,
"creationDate": "2018-01-01",
"url": "siteUrl/monUrl",
"name": "nom de portail",
"dns": "mondns",
"language": 1,
"newUserLanguage": 1,
"hasCustomLogo": false,
"lastModificationDate": "2018-01-02",
"defaultBranchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"isDefaultPortal": false,
"displayType": 1,
"createdByUserID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"keywords": "mot1,mot2,mot3",
"seoDescription": "une description",
"googleAnalyticsKey": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"providerFilter": false,
"languageFilter": false,
"isUsingCustomSupportInfo": true,
"newAccountUrl": "",
"isEmailValidatedByCode": true
},
{...}
]Description des champs
Nom | Commentaires/description |
id | Identifiant unique du portail (Type string) Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition. |
title text languageId | text : Titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
subTitle text languageId | text : Sous-titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
description text languageId | text : Description du portail telle que vue par les utilisateurs dans le système. (Type string) languageId : langue d'affichage :
(Type Number) |
newAccountButtonLabel text languageId | text : Libellé sur le bouton de création de compte. (Type string) languageId : langue d'affichage :
(Type Number) |
newAccountDescription text languageId | text : Libellé affiché avant le formulaire de création de compte. (Type string) languageId : langue d'affichage :
(Type Number) |
name | Nom du portail tel que vu par l’administration. (Type string) Ce paramètre est obligatoire en mode création. |
coverID | Identifiant pour le visuel du portail. (Type number) |
allowNewAccount | Autorisation des nouveaux utilisateurs à se créer un compte (Type Boolean) |
defaultBranchID | Branche par défaut aux nouveaux comptes créés. (Type string) allowNewAccount doit être à true pour appliquer ce champ. |
branchID | Branche du portail. (Type string) Ce paramètre est obligatoire en mode création. |
creationDate | Date de création du portail Ne peut être modifié. Disponible sur get et getlist. |
url | Url du portail. (Type string) L’url du site du client sera concaténée à la sauvegarde. Ce paramètre est obligatoire en mode création. |
dns | Dns du portail. (Type string) Passer vide pour enlever. |
language | Langue d’affichage du portail
(Type Number) |
newUserLanguage | Langue par défaut des nouveaux utilisateurs
(Type Number) |
hasCustomLogo | Indique si un logo personnalisé a été attribué au portail. |
lastModificationDate | Date de la dernière modification du portail Ne peut être modifié. Disponible sur get et getlist. |
isDefaultPortal | Indique si le portail est celui par défaut. (Type boolean) Ne peut être modifié. Disponible sur get et getlist. |
displayType | Type d’affichage dans les catalogues.
(Type Number) |
createdByUserID | Identifiant de l’utilisateur qui a créé le portail (Type string) Ne peut être modifié. Disponible sur get et getlist. -1 indique une création par l’API. |
keywords | Mots-clés pour le référencement (Type string) Les mots doivent être séparés par des virgules. Passer vide pour enlever. |
seoDescription | Description pour le référencement (Type string) Passer vide pour enlever. |
googleAnalyticsKey | Clé pour Google Analytics (Type string) Passer vide pour enlever. |
providerFilter | Désigne si les onglets de fournisseur sont utilisés pour le tri dans les catalogues. (Type boolean) |
languageFilter | Désigne si le filtre de langue est utilisé pour le tri dans les catalogues. (Type boolean) |
isUsingCustomSupportInfo | Indique si le portail utilise des informations de contact personnalisées pour l’assistance technique (Type boolean) |
newAccountUrl | Url du bouton de création de compte pour le portail. (Type string) |
isEmailValidatedByCode | Indique si le portail force la validation de courriel par code envoyé au courriel (Type boolean) |
Portails : portal/create
https://www.domaine.com/lmsapi/portal/create
| Permet de créer un portail dans votre environnement. |
Requête
Exemple de contenu d'appel de requête de création d'un portail :
{
"title": {
"texts": [{
"text": "MonPortail",
"languageId": 1
}
]
},
"branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"name": "mon nom de portail",
"url": "monurldeportail"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| title | X | Titre du portail tel que vu par les utilisateurs, sous forme de textes multilingues (texts). (Type string) |
| name | X | Nom du portail tel que vu par l’administration. (Type string) |
| url | X | Url du portail. L’url du site du client sera concaténée à la sauvegarde. (Type string) |
| branchID | X | Branche du portail. (Type string) |
| subTitle | Sous-titre du portail, sous forme de textes multilingues (texts). (Type string) | |
| description | Description du portail, sous forme de textes multilingues (texts). (Type string) | |
| coverID | Identifiant pour le visuel du portail. (Type Number) | |
| allowNewAccount | Autorisation des nouveaux utilisateurs à se créer un compte. (Type Boolean) | |
| defaultBranchID | Branche par défaut des nouveaux comptes créés. (Type string) | |
| language | Langue d’affichage du portail. (Type Number) | |
| newUserLanguage | Langue par défaut des nouveaux utilisateurs. (Type Number) | |
| displayType | Type d’affichage dans les catalogues. (Type Number) | |
| dns | Dns du portail. (Type string) | |
| keywords | Mots-clés pour le référencement. (Type string) | |
| seoDescription | Description pour le référencement. (Type string) | |
| googleAnalyticsKey | Clé pour Google Analytics. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de création d'un portail :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique du portail créé. (Type string) |
Portails : portal/edit
https://www.domaine.com/lmsapi/portal/edit
| Permet de modifier un portail existant. |
Requête
Exemple de contenu d'appel de requête d'édition d'un portail :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"title": {
"texts": [{
"text": "MonPortail",
"languageId": 1
}
]
},
"branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}Description des champs
ATTENTION : En modification, la méthode nécessite uniquement la valeur « id » comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du portail à modifier. (Type string) |
| title | Titre du portail tel que vu par les utilisateurs, sous forme de textes multilingues (texts). (Type string) | |
| name | Nom du portail tel que vu par l’administration. (Type string) | |
| url | Url du portail. L’url du site du client sera concaténée à la sauvegarde. (Type string) | |
| branchID | Branche du portail. (Type string) | |
| subTitle | Sous-titre du portail, sous forme de textes multilingues (texts). (Type string) | |
| description | Description du portail, sous forme de textes multilingues (texts). (Type string) | |
| coverID | Identifiant pour le visuel du portail. (Type Number) | |
| allowNewAccount | Autorisation des nouveaux utilisateurs à se créer un compte. (Type Boolean) | |
| defaultBranchID | Branche par défaut des nouveaux comptes créés. (Type string) | |
| language | Langue d’affichage du portail. (Type Number) | |
| newUserLanguage | Langue par défaut des nouveaux utilisateurs. (Type Number) | |
| displayType | Type d’affichage dans les catalogues. (Type Number) | |
| dns | Dns du portail. (Type string) | |
| keywords | Mots-clés pour le référencement. (Type string) | |
| seoDescription | Description pour le référencement. (Type string) | |
| googleAnalyticsKey | Clé pour Google Analytics. (Type string) |
Réponse
Exemple de contenu d'appel de réponse d'édition d'un portail :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique du portail modifié. (Type string) |
Description des codes d’erreurs de portail
Numéro | Message | Commentaires/description |
1100 | Required id | Vous devez fournir un identifiant pour le portail. |
1101 | Invalid id | L’identifiant fourni pour le portail est invalide. |
1102 | Required branch id | Vous devez fournir un identifiant pour la branche. |
1103 | Invalid branch id | L’identifiant fourni pour la branche est invalide. |
1104 | Required url | Vous devez fournir une url. |
1105 | Invalid url | L’url fournie est invalide. |
1106 | Invalid cover id | L’identifiant fourni pour le visuel est invalide. |
1107 | Required name | Vous devez fournir un nom pour le portail. |
1108 | Invalid name length | La taille du nom fourni pour le portail est invalide. |
1109 | Required title | Vous devez fournir un titre pour le portail. |
1110 | Invalid title length | La taille du titre fourni pour le portail est invalide. |
1111 | Invalid subTitle length | La taille du sous-titre fourni pour le portail est invalide. |
1112 | Invalid description length | La taille de la description fournie pour le portail est invalide. |
1113 | Invalid default branch id | L’identifiant fourni pour la branche par défaut est invalide. |
1114 | Error linking external auth | Une erreur est survenue lors de la création du lien entre le portail et la méthode d’authentification. |
1115 | Invalid newAccountUrl length | L’url pour le bouton de création de compte est invalide. |
1116 | Invalid newAccountButtonLabel length | La taille du libellé de bouton de création de compte est invalide. |