Guide d'installation de l'API
Guide de référence
Point de changement 2021
© 2021 Changepoint Canada SRI Tous droits réservés. DROITS DU GOUVERNEMENT DES ÉTATS-UNIS - L'utilisation, la duplication ou la divulgation par le gouvernement des États-Unis sont assujetties aux restrictions énoncées dans l'accord de licence de Changepoint Canada ULC et aux dispositions des DFARS 227.7202-1(a) et 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19 ou FAR 52.227-14 (ALT III), selon le cas. Ce produit contient des informations confidentielles et des secrets commerciaux de Changepoint Canada ULC. La divulgation est interdite sans l'autorisation écrite expresse préalable de Changepoint Canada ULC. L'utilisation de ce produit est soumise aux termes et conditions du contrat de licence de l'utilisateur avec Changepoint Canada ULC. La documentation ne peut être reproduite par le Licencié qu'à des fins internes. Le contenu de ce document ne peut être altéré, modifié ou changé sans le consentement écrit exprès de Changepoint Canada ULC. Changepoint Canada ULC peut modifier le contenu spécifié aux présentes à tout moment, avec ou sans préavis.
Installation de l'API Changepoint
À propos de l'installation de l'API Changepoint
L'API Changepoint est disponible sous la forme d'une API COM, d'un service Windows Communication Foundation (WCF) et, pour la rétrocompatibilité, sous la forme d'un Web Service d'amélioration des services (WSE). Pour plus d'informations sur l'API Changepoint, consultez la référence de l'API Changepoint. Pour les notes de mise à niveau, les mises en garde et les problèmes connus, consultez les notes de version dans les dossiers d'équipe dans Changepoint.
Mise à niveau de l'API Changepoint
Si vous effectuez une mise à niveau à partir d'une version précédente de Changepoint, utilisez le Panneau de configuration Windows pour désinstaller la version précédente de l'API Changepoint et de ses composants avant d'installer cette version.
Exigences de l'API Changepoint
Vous devez installer Changepoint avant d'installer l'API Changepoint. Pour connaître la configuration logicielle requise, consultez la matrice de compatibilité logicielle de Changepoint, qui est disponible dans le dossier d'équipe Notes de version et correctifs 2021 de Changepoint.
File conventions de chemin
Tout au long de ce document, les conventions suivantes sont utilisées pour les chemins communs :
- Le chemin racine de l'installation de Changepoint.
Le chemin par défaut est :
C:Programme Files (x86)Point de changementPoint de changement - L'emplacement racine des utilitaires Changepoint courants, tels que l'utilitaire Paramètres de connexion.
Le chemin par défaut est :
C:Programme Files (x86)Commun FilesPoint de changementPoint de changement
Installation de l'API Changepoint
- À partir du répertoire racine du support de l'API Changepoint, exécutez setup.exe.
- Suivez les invites jusqu'à ce que l'écran Sélectionner les fonctionnalités s'affiche.
- Sélectionnez les fonctionnalités que vous souhaitez installer, puis cliquez sur Suivant.
- Sélectionnez le dossier de destination de l'API, par défaut API, puis cliquez sur Suivant.
Note: L'utilitaire Changepoint Login Settings est installé dans LoginSettings, quel que soit le dossier de destination que vous spécifiez. - Si vous avez sélectionné le Web API de services : a. Lorsque le bouton Sélectionner
a Web L'écran du site apparaît, sélectionnez un website auquel ajouter le répertoire virtuel, puis cliquez sur Suivant.
b. Cliquer sur Suivant pour continuer. 6. Une fois l'installation de l'API terminée, cliquez sur Terminer.
Configuration de l'API Changepoint pour qu'elle soit consciente du cache
Pour configurer l'API Changepoint pour qu'elle tienne compte du cache, remplacez les valeurs de "cache. Mot de passe » et « cache. Clés "serveurs" dans le CP Web ServicesWeb.config file avec les valeurs utilisées dans l'entrepriseWeb.config file.
Activation Web Améliorations des services (WSE)
- Modifier le Web.config file pour web prestations de service. L'emplacement par défaut est :
APICP Web ServicesWeb.config - Recherchez les trois instances de la ligne de commentaire suivante :
< !– Décommentez l'élément suivant si vous utilisez Web API d'amélioration des services (WSE). Laissez des commentaires si vous utilisez les services WCF et que vous n'installez pas Web Améliorations de service (WSE) -> - Décommentez l'élément qui suit chaque instance de la ligne de commentaire :
<section name=”microsoft.web.services2″ … >webPrestations>web.services2>
Note: LewebServices> l'élément à décommenter est un enfant deweb>.
Configuration de la journalisation pour le Web API de services
Vous devez définir le journal file chemin d'accès et niveaux de journalisation. Les niveaux de log sont cumulatifs. Par exempleample, si vous spécifiez le niveau 3, les niveaux 1, 2 et 3 sont enregistrés. Le niveau de journalisation par défaut est 8.
- Modifier le web services Web.config. L'emplacement par défaut est :
APICP Web ServicesWeb.config - Définir le journalFileChemin. La valeur par défaut est APIAPILogs. 3. Définissez le niveau de journalisation. Les valeurs valides sont :
0 = Pas de journalisation
1 = Objet source et méthode
2 = message d'erreur
3 = Paramètres d'entrée
4 = Retours
5 = Avertissement
8 = Point de contrôle
Configuration de l'authentification du répertoire virtuel pour le Web API de services
Vous devez activer l'accès anonyme et désactiver l'authentification Windows intégrée pour le CPWebRépertoire virtuel de service dans Internet Information Services (IIS). Pour plus d'informations, consultez la documentation de Microsoft IIS.
Configuration des paramètres de connexion à la base de données pour le Web API de services
Utilisez l'utilitaire Paramètres de connexion pour crypter les paramètres de connexion à la base de données dans Web API de services Web.config file. Pour plus d'informations, recherchez « Configuration des paramètres de connexion à la base de données » dans le Guide d'installation de Changepoint.
Configuration de l'authentification pour Changepoint WCF Web Services
Vous pouvez configurer l'authentification d'application et l'authentification unique (SSO) pour Changepoint WCF Web Services.
Les options de mise en œuvre suivantes sont disponibles à l'aide de Secure Token Service (STS) :
- SSO utilisant ISAPI SSL facultatif
- SSO utilisant WS-Federation (ADFS 2.0) SSL requis
Si SSL est requis, le script de configuration s'assure qu'il est utilisé.
Les scripts de configuration pour ISAPI et l'authentification d'application peuvent éventuellement activer SSL.
Configuration de l'authentification d'application pour WCF Web Services
Le type d'authentification par défaut pour Changepoint WCF Web Services est l'authentification de l'application.
Utilisez les procédures de cette section pour :
- configurer le point de changement WCF Web Services pour utiliser l'authentification d'application avec SSL
- rétablir le point de changement WCF Web Services à l'authentification des applications après avoir implémenté l'une des implémentations SSO
Configurer PowerShell
- Ouvrez une invite Windows PowerShell.
- Modifiez la politique d'exécution :
Set-ExecutionPolicy sans restriction
Stage 1 Collecter les paramètres de configuration
Déterminez les valeurs des paramètres de configuration.
| Paramètre | Description |
| WebChemin_service | Emplacement du point de changement WCF Web Services web application files. Défaut: \API\CP Web Services |
| Certificat de service_ Nom |
Nom du certificat qui sera utilisé pour authentifier le service auprès des clients utilisant le mode de sécurité Message. Par défaut : le nom du certificat "CN=ChangepointAPICertificate". |
| nécessite HTTPS | HTTPS requis (vrai/faux) Par défaut : Faux. |
Stage 2 Exécuter les scripts de configuration
Utilisez les valeurs des paramètres de configuration pour modifier la configuration du websites.
- Ouvrez une invite PowerShell.
Note: Si le contrôle de compte d'utilisateur est activé sur votre serveur, vous devez ouvrir l'invite PowerShell à l'aide d'autorisations d'administrateur élevées. - Naviguer vers le CP web répertoire de configuration du service, par défaut :
ConfigurationCPWebService - Exécutez ./Configuration_AppAuth.ps1
- Suivez les instructions.
Configuration de l'authentification unique (SSO) pour WCF Web Services
Configurer PowerShell
- Ouvrez une invite Windows PowerShell.
- Modifiez la politique d'exécution :
Set-ExecutionPolicy sans restriction
Configuration de SSO à l'aide d'ISAPI pour WCF Web Services
Stage 1 Collecter les paramètres de configuration
Déterminez les valeurs des paramètres de configuration suivants.
| Paramètre | Description |
| WebChemin_service | L'emplacement du Changepoint WCF Web Services web application files. Défaut: \API\CP Web Services |
| nécessite HTTPS | Requiert HTTPS (vrai/faux). Par défaut : Faux. |
| Point de changement_RSA_ Cookie_Transformation |
Le nom du certificat que vous utilisez pour le chiffrement des cookies. Par défaut : le nom du certificat "CN=ChangepointAPICertificate". |
| ServiceCertificate_Name | Saisissez le nom du certificat qui sera utilisé pour authentifier le service auprès des clients utilisant le mode de sécurité Message. Par défaut : le nom du certificat "CN=ChangepointAPICertificate". |
| SigningCertificate_Name | Entrez le nom du certificat de signature. Il s'agit du nom du certificat que vous utilisez pour signer les messages. Par défaut : le nom du certificat "CN=ChangepointAPICertificate". |
| Mode_ISAPI | Le mode ISAPI. Par défaut : NT |
| ISAPI_En-tête | L'en-tête utilisé lorsque ISAPI_Mode est "HEADER", par exempleample, vide. |
| Type de réclamation | Entrez le type de demande SSO. Défaut: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Exécuter les scripts de configuration
- Ouvrez une invite PowerShell.
Note: Si le contrôle de compte d'utilisateur est activé sur votre serveur, vous devez ouvrir l'invite PowerShell à l'aide d'autorisations d'administrateur élevées. - Naviguer vers le CP web répertoire de configuration du service, par défaut :
ConfigurationCPWebService - Exécutez : ./Configuration_SSO_ISAPI.ps1
- Suivez les instructions.
Configuration de SSO à l'aide de WS-Federation (ADFS 2.0) pour WCF Web Services
Stage 1 Collecter les paramètres de configuration
Déterminez les valeurs des paramètres de configuration dans le tableau ci-dessous. Assurez-vous que l'ADFS_Server_URI se trouve dans la zone Intranet du navigateur de l'utilisateur final.
Note: Par défaut, Changepoint est configuré pour mettre à jour automatiquement les clés publiques utilisées pour signer les jetons de sécurité à l'aide du document de métadonnées de fédération publié. Dans ADFS c'est :
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Dans certains cas, il peut ne pas être possible d'atteindre le serveur ADFS à partir du point de changement web serveur, vous devrez donc mettre à jour manuellement la configuration après avoir exécuté le script de configuration. Pour plus de détails, voir « Mise à jour manuelle des clés publiques » à la page 12.
| Paramètre | Description |
| WebChemin_service | Emplacement du point de changement WCF Web Services web application files. Défaut: \API\CP Web Services |
| WebService_URI | Identifiant de domaine que vous utilisez pour Changepoint WCF Web Prestations de service. Par exempleampc.-à-d., https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_Cookie_Transform | Nom du certificat que vous utilisez pour le chiffrement des cookies. Par défaut : le nom du certificat "CN=ChangepointApiCertificate". |
| ServiceCertificate_Name | Nom du certificat qui sera utilisé pour authentifier le service auprès des clients utilisant le mode de sécurité Message. Par défaut : le nom du certificat "CN=ChangepointApiCertificate". |
| SigningCertificate_Name | Nom du certificat que vous utilisez pour signer les messages. Par défaut : le nom de certificat "CN=ChangepointApiCertificate" est utilisé. |
| ADFS_FederationServiceName | Nom du service de fédération. Pour obtenir le nom : À partir du serveur ADFS, lancez la console de gestion ADFS 2.0. • Sélectionnez ADFS 2.0 dans le menu de gauche. • Dans le volet Action, sélectionnez Modifier les propriétés du service de fédération. Le nom du service de fédération se trouve dans l'onglet Général. |
| Type de réclamation | Type de demande SSO. La valeur par défaut est : http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 Exécuter les scripts de configuration
Configurer le websites en utilisant les valeurs des paramètres de configuration.
- Ouvrez une invite PowerShell.
Note: Si le contrôle de compte d'utilisateur est activé sur votre serveur, vous devez ouvrir l'invite PowerShell à l'aide d'autorisations d'administrateur élevées. - Naviguer vers le point de changement web répertoire de configuration du service, par défaut : ConfigurationCPWebService
- Exécutez : ./Configuration_SSO_ADFS.ps1
- Suivez les instructions.
Stage 3 Créer une approbation de partie de confiance
Créez l'approbation de la partie de confiance dans la console ADFS 2.0.
- Sur votre serveur ADFS, lancez la console ADFS 2.0.
- Sélectionnez Action > Ajouter une approbation de partie de confiance.
- Cliquez sur Démarrer.
- Sélectionnez Importer des données sur la partie utilisatrice publiées en ligne ou sur un réseau local.
- Entrez l'adresse des métadonnées de la fédération, puis cliquez sur Suivant, par exempleample:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - Entrez un nom d'affichage, par exemple Changepoint WCF API, et cliquez sur Suivant, Suivant, Suivant, puis Fermer.
- Ajoutez une règle de réclamation pour la partie utilisatrice du point de changement ci-dessus. Pour Changepoint, le nom de la règle de revendication par défaut est "UPN".
- Mappez l'attribut LDAP "User-Principal-Name" au type de demande sortante "* UPN" ou "UPN".
Mettre à jour manuellement les clés publiques
Pour obtenir l'empreinte numérique de signature de jeton du serveur ADFS
- À partir du serveur ADFS, lancez la console de gestion ADFS 2.0.
- Sélectionnez Service > Certificats et double-cliquez sur le certificat de signature de jeton.
- Sélectionnez l’onglet Détails.
- Sélectionnez le champ Empreinte numérique.
- Pour obtenir la valeur de l'empreinte numérique, supprimez tous les espaces, y compris le premier espace.
Pour mettre à jour le Web.config file
- Modifier l'ADFS web.config. L'emplacement par défaut est :
EntrepriseRP-STS_ADFS - Sous le , recherchez la clé ida:FederationMetadataLocation et effacez sa valeur :
- En dessous de , trouvez le élément et remplacez-le par ce qui suit : https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />
Test de la connexion à l'API COM
- Exécutez le kit de test API. L'emplacement par défaut est :
APIComposants APIApiTestKit.exe. - Cliquez sur Chaîne de connexion > Chiffreur.
- Dans le champ Chaîne de connexion en texte brut :
un. Remplacez SERVERNAME et DATABASENAME par les informations de votre base de données.
b. Remplacez USERID et PASSWORD par les informations de votre compte utilisateur d'administrateur de base de données.
c. Entrez la valeur du délai d'attente selon vos besoins. - Cliquez sur Crypter.
- Dans le champ Chaîne de connexion chiffrée, copiez le texte.
- Fermer la boîte de dialogue.
- Dans le menu Kit de test API, cliquez sur Connexion > Testeur de connexion API COM.
- Dans l'onglet Version actuelle, collez la chaîne de connexion chiffrée dans le champ Chaîne de connexion.
- Dans les champs LoginId et Password, entrez l'ID de connexion et le mot de passe de votre compte Changepoint.
- Dans le champ Loglevel (0-8), spécifiez le niveau d'informations d'erreur à renvoyer dans le journal de l'API COM file si le résultat du test indique un problème de connexion.
0 = Pas de journalisation
1 = Objet source et méthode
2 = message d'erreur
3 = Paramètres d'entrée
4 = Retours
5 = Avertissement
8 = Point de contrôle
La valeur par défaut est 8. - Cliquez sur Connecter.
Si la connexion a réussi, un message de réussite s'affiche dans le champ Résultat. Si la connexion a échoué, vérifiez le journal de l'API COM file pour les erreurs. L'emplacement par défaut du journal file est APIAPILogs.
Vérification de la version des composants d'API installés
Vous pouvez utiliser l'utilitaire de vérification de version pour obtenir des détails sur les composants installés, y compris la version et le chemin d'accès.
- Exécutez CPVersionChecker.exe. Le chemin par défaut est : Composants APIAPI
- Cliquez sur Lire.
Vérification de la version du Web API de services
- Lancez Internet Explorer à partir du serveur sur lequel Web L'API Services est installée et saisissez l'adresse :
http://localhost.port/CPWeb.Service/WSLogin.asmx où port est le numéro de port du website où vous avez installé le CPWebRépertoire virtuel des services. - Sur la page WSLogin, cliquez sur le lien GetVersion.
- Cliquez sur Appeler.
Tester le Web Connexion à l'API des services
- Lancez Internet Explorer à partir du serveur sur lequel Web L'API Services est installée et saisissez l'adresse : http://localhost.port/CPWeb.Service/WSLogin.asmx où port est le numéro de port du website où vous avez installé le CPWebRépertoire virtuel des services.
- Sur la page WSLogin, cliquez sur le lien TestConnection.
- Cliquez sur Appeler. 4. Dans les résultats du test :
- Si est faux, le test de connexion a réussi.
- Si est vrai, le test de connexion a échoué. Pour plus
informations sur les raisons de l'échec, voir le et éléments dans les résultats du test et vérifiez les journaux de l'API. Le chemin d'accès par défaut aux journaux d'API est : APIAPILogs
Mise en place de la Web API de services sur un serveur de langage
- Pour déployer le point de changement Web API Services sur un serveur de langage, vous devez ajouter ou mettre à jour le tag dans le Web API de services web.config. L'emplacement par défaut du Web.config file est: APICP Web ServicesWeb.config
- Si la tag existe déjà, assurez-vous que les attributs culture et uiCulture sont "en-US".
- Si la tag n'existe pas déjà, ajoutez ce qui suit , commentaire et éléments à laweb> nœud :web>
Options Visual Basic : définissez strict="true" pour interdire toutes les conversions de type de données pouvant entraîner une perte de données. Définissez explicit="true" pour forcer la déclaration de toutes les variables. –> - Redémarrez IIS.
Documents / Ressources
 |
Logiciel d'API de point de changement [pdf] Guide d'installation API, Logiciel, Logiciel API |
