API OpenFlyers - Revision history

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:34:05Z

Récupérer les rapports génériques

← Older revision		Revision as of 14:34, 23 April 2025
Line 1,454:		Line 1,454:
	La réponse est un fichier CSV retourné dans un conteneur JSON.		La réponse est un fichier CSV retourné dans un conteneur JSON.

	le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.		Le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.

	Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].		Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:33:47Z

Récupérer les rapports génériques

← Older revision		Revision as of 14:33, 23 April 2025
Line 1,458:		Line 1,458:
	Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].		Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

	Exemple avec le rapport [[[[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.		Exemple avec le rapport [[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.

	===Récupérer les rapports personnalisés===		===Récupérer les rapports personnalisés===

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:33:30Z

Récupérer les rapports génériques

← Older revision		Revision as of 14:33, 23 April 2025
Line 1,453:		Line 1,453:

	La réponse est un fichier CSV retourné dans un conteneur JSON.		La réponse est un fichier CSV retourné dans un conteneur JSON.

			le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.

			Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

			Exemple avec le rapport [[[[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.

	===Récupérer les rapports personnalisés===		===Récupérer les rapports personnalisés===

Claratte at 21:39, 13 February 2025

2025-02-13T21:39:41Z

Show changes

Lhenry: /* Script client : Authorization Code */

2025-02-13T18:22:20Z

Script client : Authorization Code

← Older revision		Revision as of 20:22, 13 February 2025
Line 260:		Line 260:

	Fichier de configuration ''config.authcode.json'' :		Fichier de configuration ''config.authcode.json'' :
	<javascript>{		<syntaxhighlight lang="javascript">{
	"client_id": "",		"client_id": "",
	"client_secret": "",		"client_secret": "",
Line 272:		Line 272:
	"auth_cacert": "/path/to/ca.crt",		"auth_cacert": "/path/to/ca.crt",
	"sign_cert_server": "/path/to/server/sign_cert_server.crt"		"sign_cert_server": "/path/to/server/sign_cert_server.crt"
	}</~~javascript~~>		}</syntaxhighlight>
	Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.		Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
	*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.		*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
Line 280:		Line 280:

	Script PHP :		Script PHP :
	<php><?php		<syntaxhighlight lang="php"><?php
	$localTokenFile = 'token.json';		$localTokenFile = 'token.json';
	// create token file if it does not exist		// create token file if it does not exist
Line 769:		Line 769:
	}		}
	die();		die();
	}</~~php~~>		}</syntaxhighlight>

	;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.		;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

Lhenry: /* Générer les codes pour PKCE */

2025-02-13T18:21:32Z

Générer les codes pour PKCE

← Older revision		Revision as of 20:21, 13 February 2025
Line 180:		Line 180:

	;Générer le ''code_verifier''		;Générer le ''code_verifier''
	<php>function generateCodeVerifier($length = 128): string		<syntaxhighlight lang="php">function generateCodeVerifier($length = 128): string
	{		{
	$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';		$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
Line 191:		Line 191:

	return $outputCode;		return $outputCode;
	}</~~php~~>		}</syntaxhighlight>

	Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.		Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.

	;Générer le ''code_challenge''		;Générer le ''code_challenge''
	<php>function computeCodeChallenge(string $codeVerifier): string		<syntaxhighlight lang="php">function computeCodeChallenge(string $codeVerifier): string
	{		{
	return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');		return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
	}</~~php~~>		}</syntaxhighlight>

	Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.		Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.


	===Demande d'autorisation===		===Demande d'autorisation===

Lhenry: /* Signature */

2025-02-13T18:20:28Z

Signature

← Older revision		Revision as of 20:20, 13 February 2025
Line 87:		Line 87:

	;Exemple en php		;Exemple en php
	<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string		<syntaxhighlight lang="php">function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
	{		{
	// generating the signing string and header list		// generating the signing string and header list
Line 109:		Line 109:
	// compiling the header line		// compiling the header line
	return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";		return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
	}</~~php~~>		}</syntaxhighlight>
	Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.		Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

	La variable ''$headersToSign'' est un tableau formaté de la manière suivante :		La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
	<php>[		<syntaxhighlight lang="php">[
	$headerName => $headerValue,		$headerName => $headerValue,
	...		...
	]</~~php~~>		]</syntaxhighlight>

	'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.		'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

Claratte: /* Authorization Code */

2024-12-09T09:35:22Z

Authorization Code

← Older revision		Revision as of 11:35, 9 December 2024
Line 130:		Line 130:
	Ce flux OAuth2 se déroule en plusieurs étapes :		Ce flux OAuth2 se déroule en plusieurs étapes :
	*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.		*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
	*Le navigateur de l'utilisateur est redirigé vers l'URL ~~fourni~~ durant la demande ou durant l'enregistrement du client.		*Le navigateur de l'utilisateur est redirigé vers l'URL fournie durant la demande ou durant l'enregistrement du client.
	*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.		*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
	*Le client peut utiliser ce code d'accès :		*Le client peut utiliser ce code d'accès :

Lhenry: Text replacement - "Fichier:" to "File:"

2024-10-02T17:27:47Z

Text replacement - "Fichier:" to "File:"

← Older revision		Revision as of 19:27, 2 October 2024
Line 1,471:		Line 1,471:
	Le code source est structuré de la manière suivante :		Le code source est structuré de la manière suivante :

	[[~~Fichier~~:Oauth2 src demo folder.png\|800px]]		[[File:Oauth2 src demo folder.png\|800px]]

	* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.		* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
Line 1,481:		Line 1,481:
	Le dossier '''ssl''' doit respecter la structure suivante :		Le dossier '''ssl''' doit respecter la structure suivante :

	[[~~Fichier~~:Oauth2 demo tree.png]]		[[File:Oauth2 demo tree.png]]

	;[[#Générer des certificats\|Générer les certificats]] :		;[[#Générer des certificats\|Générer les certificats]] :
Line 1,492:		Line 1,492:
	**Le second pour le mécanisme d'autorisation '''Client Credentials'''.		**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

	[[~~Fichier~~:Oauth2 demo manage.png\|800px]]		[[File:Oauth2 demo manage.png\|800px]]

	*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.		*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.
Line 1,571:		Line 1,571:
	;Créer un nouveau client OAuth2		;Créer un nouveau client OAuth2
	*Aller dans '''Admin > Transferts > Exports > API OAuth2'''		*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
	[[~~Fichier~~:Oauth2 manage.png\|800px]]		[[File:Oauth2 manage.png\|800px]]
	*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''		*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
	[[~~Fichier~~:Oauth2 client creation.png\|800px]]		[[File:Oauth2 client creation.png\|800px]]
	*Choisir un nom pour le client.		*Choisir un nom pour le client.
	*Sélectionner le mécanisme d'autorisation utilisé par le client :		*Sélectionner le mécanisme d'autorisation utilisé par le client :
Line 1,584:		Line 1,584:
	**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).		**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

	[[~~Fichier~~:PublicKeysCopyScreen.png\|900px]]		[[File:PublicKeysCopyScreen.png\|900px]]


Line 1,595:		Line 1,595:
	Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,		Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
	et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.		et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
	[[~~Fichier~~:Oauth2 client created.png]]		[[File:Oauth2 client created.png]]

	[[~~Fichier~~:ConfigCredJsonScreen.png\|600px]]		[[File:ConfigCredJsonScreen.png\|600px]]


	;Télécharger les certificats crt		;Télécharger les certificats crt
	Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.		Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
	[[~~Fichier~~:Oauth2 client certificates.png]]		[[File:Oauth2 client certificates.png]]

	;Téléchargez les certificats du serveur.		;Téléchargez les certificats du serveur.
	*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.		*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
	[[~~Fichier~~:DownloadServerCertifScreen.png\|900px]]		[[File:DownloadServerCertifScreen.png\|900px]]
	*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.		*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
	*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:		*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
Line 1,692:		Line 1,692:
	**Le second pour le mécanisme d'autorisation '''Client Credentials'''.		**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

	[[~~Fichier~~:Oauth2 demo manage.png\|800px]]		[[File:Oauth2 demo manage.png\|800px]]

	*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.		*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
Line 1,746:		Line 1,746:
	**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.		**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
	**Glisser et déposer le oauth-demo à l'emplacement choisi.		**Glisser et déposer le oauth-demo à l'emplacement choisi.
	[[~~Fichier~~:Transfer OauthDemo To Shared Server.png\|800px]]		[[File:Transfer OauthDemo To Shared Server.png\|800px]]
	*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php		*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
	*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.		*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.
Line 1,765:		Line 1,765:
	Le client de démonstration se présente de la manière suivante.		Le client de démonstration se présente de la manière suivante.

	[[~~Fichier~~:Oauth2-client-demo.png]]		[[File:Oauth2-client-demo.png]]

	La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code\|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials\|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.		La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code\|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials\|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.
Line 1,777:		Line 1,777:
	Une fois les informations saisies, la page suivante est affichée.		Une fois les informations saisies, la page suivante est affichée.

	[[~~Fichier~~:Oauth authorize demo.png]]		[[File:Oauth authorize demo.png]]

	*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).		*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).
Line 1,791:		Line 1,791:
	Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.		Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

	[[~~Fichier~~:Oauth2 connected demo.png]]		[[File:Oauth2 connected demo.png]]

	=Troubleshooting=		=Troubleshooting=

imported>Claratte: /* Prolonger la durée de vie de la session du client de démonstration */

2024-02-02T13:33:30Z

Prolonger la durée de vie de la session du client de démonstration

← Older revision		Revision as of 15:33, 2 February 2024
Line 1,318:		Line 1,318:
	La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).		La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

	Pour permettre à la session de rester active même après la fermeture du navigateur, ~~nous utilisons~~ la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode ~~nous~~ donne la possibilité de définir une durée de vie pour les différents cookies associés à ~~notre~~ session.		Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
	<php>		<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
	// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
	$oauth2DemoSessionLifeTime = time() + (86400 * 30);		$oauth2DemoSessionLifeTime = time() + (86400 * 30);
	session_set_cookie_params($oauth2DemoSessionLifeTime);		session_set_cookie_params($oauth2DemoSessionLifeTime);</php>
	</php>

	NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.		NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.