OAuth2 est le protocole d'autorisation standard du secteur. Il permet aux utilisateurs d'autoriser les applications Web et de bureau à accéder aux informations privées sans partager leur nom d'utilisateur, leur mot de passe et d'autres identifiants privés.
Ce tutoriel crée une extension qui accède aux contacts Google d'un utilisateur à l'aide de l'API Google People et de l'API Chrome Identity. Étant donné que les extensions ne se chargent pas via HTTPS et ne peuvent pas effectuer de redirections ni définir de cookies, elles s'appuient sur l'API Chrome Identity pour utiliser OAuth2.
Premiers pas
Commencez par créer un répertoire et les fichiers de démarrage suivants.
L'extension complète est téléchargeable sur cette page.
manifest.json
Ajoutez le fichier manifeste en créant un fichier nommé manifest.json et en incluant le code suivant. Vous pouvez également télécharger le fichier.
{
"name": "OAuth Tutorial FriendBlock",
"version": "1.0",
"description": "Uses OAuth to connect to Google's People API and display contacts photos.",
"manifest_version": 2,
"browser_action": {
"default_title": "FriendBlock, friends face's in a block."
},
"background": {
"scripts": [
"background.js"
],
"persistent": false
}
}
background.js
Ajoutez le script en arrière-plan en créant un fichier nommé background.js et en incluant le code suivant.
Vous pouvez aussi télécharger le fichier.
chrome.browserAction.onClicked.addListener(function() {
chrome.tabs.create({url: 'index.html'});
});
index.html
Ajoutez un fichier HTML appelé index.html et incluez le code suivant. Vous pouvez aussi télécharger le fichier.
<html>
<head>
<title>FriendBlock</title>
<style>
button {
padding: 10px;
background-color: #3C79F8;
display: inline-block;
}
</style>
</head>
<body>
<button>FriendBlock Contacts</button>
<div id="friendDiv"></div>
</body>
</html>
Importer dans le tableau de bord du développeur
Empaquetez le répertoire de l'extension dans un fichier .zip, puis importez-le dans le tableau de bord du développeur Chrome sans le publier:
- Dans le tableau de bord du développeur, cliquez sur Ajouter un élément.
- Cliquez sur Sélectionner un fichier, sélectionnez le répertoire de l'extension
.zip, puis importez-le. - Sans remplir de champs supplémentaires, sélectionnez Enregistrer le brouillon et revenir au tableau de bord.
Recherchez l'extension sous Your Listings (Vos fiches), puis cliquez sur More info (Plus d'infos). Dans le pop-up, copiez la clé publique et ajoutez-la au fichier manifeste dans le répertoire décompressé, sous le champ "key".
{
"name": "OAuth Tutorial FaceBlcok",
...
"key": "ThisKeyIsGoingToBeVeryLong/go8G...AQAB"
}
Comparer les ID
Ouvrez la page de gestion des extensions à l'adresse chrome://extensions, assurez-vous que le mode développeur est activé et importez le répertoire d'extensions non empaqueté. Comparez l'ID d'extension sur la page de gestion des extensions à celui de l'élément dans le tableau de bord du développeur. Ils doivent concorder.
L'extension conservera le même ID en incluant le champ "key" dans le fichier manifeste. La conservation d'un seul ID est essentielle pour l'enregistrement de l'API.
Créer un ID client OAuth
Accédez à la console Google APIs et créez un projet. Lorsque vous êtes prêt, sélectionnez Identifiants dans la barre latérale, cliquez sur Créer des identifiants et choisissez ID client OAuth.
Sur la page "Créer un ID client", sélectionnez Application Chrome. Indiquez le nom de l'extension et placez l'ID d'extension à la fin de l'URL dans le champ "ID application".
Pour terminer, cliquez sur "Créer". La console fournit un ID client OAuth.
Enregistrer OAuth dans le fichier manifeste
Incluez le champ "oauth2" dans le fichier manifeste de l'extension. Placez l'ID client OAuth généré sous "client_id". Incluez une chaîne vide dans "scopes" pour le moment.
{
"name": "OAuth Tutorial FriendBlock",
...
"oauth2": {
"client_id": "yourExtensionOAuthClientIDWillGoHere.apps.googleusercontent.com",
"scopes":[""]
},
...
}
Lancer le premier flux OAuth
Enregistrez l'autorisation identity dans le fichier manifeste.
{
"name": "OAuth Tutorial FaceBlcok",
...
"permissions": [
"identity"
],
...
}
Créez un fichier nommé oauth.js pour gérer le flux OAuth et incluez le code suivant. Vous pouvez aussi le télécharger ici.
window.onload = function() {
document.querySelector('button').addEventListener('click', function() {
chrome.identity.getAuthToken({interactive: true}, function(token) {
console.log(token);
});
});
};
Placez un tag de script pour oauth.js dans l'en-tête de index.html.
...
<head>
<title>FriendBlock</title>
...
<script type="text/javascript" src="oauth.js"></script>
</head>
...
Actualisez l'extension et cliquez sur l'icône du navigateur pour ouvrir index.html. Ouvrez la console et cliquez
sur le bouton « FriendBlock Contacts ». Un jeton OAuth s'affiche dans la console.
Activer l'API Google People
Revenez à la console Google APIs, puis sélectionnez Bibliothèque dans la barre latérale. Recherchez "API Google People", cliquez sur le résultat qui vous intéresse et activez-le.
Ajoutez la bibliothèque cliente de l'API Google People à "scopes" dans le fichier manifeste de l'extension.
{
"name": "OAuth Tutorial FaceBlcok",
...
"oauth2": {
"client_id": "yourExtensionOAuthClientIDWillGoHere.apps.googleusercontent.com",
"scopes": [
"https://www.googleapis.com/auth/contacts.readonly"
]
},
...
}
Revenez à la console Google APIs et revenez aux identifiants. Cliquez sur "Créer des identifiants", puis sélectionnez "Clé API" dans le menu déroulant.
Conservez la clé API générée pour une utilisation ultérieure.
Créer votre première requête API
Maintenant que l'extension dispose des autorisations et des identifiants appropriés, et qu'elle peut autoriser un utilisateur Google, elle peut demander des données via l'API People. Mettez à jour le code dans oauth.js pour qu'il corresponde à ce qui est indiqué ci-dessous.
window.onload = function() {
document.querySelector('button').addEventListener('click', function() {
chrome.identity.getAuthToken({interactive: true}, function(token) {
let init = {
method: 'GET',
async: true,
headers: {
Authorization: 'Bearer ' + token,
'Content-Type': 'application/json'
},
'contentType': 'json'
};
fetch(
'https://people.googleapis.com/v1/contactGroups/all?maxMembers=20&key=API_KEY',
init)
.then((response) => response.json())
.then(function(data) {
console.log(data)
});
});
});
};
Remplacez API_KEY par la clé API générée à partir de la console Google APIs. L'extension doit consigner un objet JSON qui comprend un tableau de people/account_id sous le champ memberResourceNames.
Bloquer des visages
Maintenant que l'extension renvoie une liste des contacts de l'utilisateur, elle peut effectuer des requêtes supplémentaires pour récupérer les profils et les informations de ces contacts . L'extension utilisera memberResourceNames pour récupérer les informations sur les photos des contacts des utilisateurs. Mettez à jour oauth.js pour inclure le code suivant.
window.onload = function() {
document.querySelector('button').addEventListener('click', function() {
chrome.identity.getAuthToken({interactive: true}, function(token) {
let init = {
method: 'GET',
async: true,
headers: {
Authorization: 'Bearer ' + token,
'Content-Type': 'application/json'
},
'contentType': 'json'
};
fetch(
'https://people.googleapis.com/v1/contactGroups/all?maxMembers=20&key=<API_Key_Here>',
init)
.then((response) => response.json())
.then(function(data) {
let photoDiv = document.querySelector('#friendDiv');
let returnedContacts = data.memberResourceNames;
for (let i = 0; i < returnedContacts.length; i++) {
fetch(
'https://people.googleapis.com/v1/' + returnedContacts[i] +
'?personFields=photos&key=API_KEY',
init)
.then((response) => response.json())
.then(function(data) {
let profileImg = document.createElement('img');
profileImg.src = data.photos[0].url;
photoDiv.appendChild(profileImg);
});
};
});
});
});
};
Actualisez la page et revenez à l'extension. Cliquez sur le bouton « amiBlock » et c'est parti ! Profitez des visages de vos contacts dans un même bloc.
