source: spip-zone/_plugins_/connecteur/trunk/README.md @ 98181

Last change on this file since 98181 was 96247, checked in by p@…, 4 years ago

Mise à jour de la documentation

File size: 1.8 KB
Line 
1# Connecteur Universel SPIP
2
3Le connecteur universel implémente la partie création et connexion d'auteur SPIP via un provider indépendant.
4
5## Implémentation d'un SDK
6
7### Configurer un connecteur
8
9Il faut créer, dans un fichier connecteur/*type*_config.php une fonction connecteur_*type*_config_dist.
10
11Cette fonction renvoie simplement un tableau contenant la configuration du connecteur :
12
13```php
14return array(
15        'connecteur' => 'token', // Type de connecteur
16        'type' => 'facebook', // Pour la forme
17        // Fonction de l'API pour trouver le token
18        'trouver_token' => 'facebook_access_token',
19        // Charger un fichier avant d'executer la fonction trouver_token
20        'charger_fichier' => 'inc/facebook'
21);
22```
23
24### Lien de connexion
25
26#### Le lien
27La première étape consiste à définir la fonction qui créer le lien (html) de connexion dans un fichier connecteur/*type*_lien.php avec une fonction connecteur_*type*_lien_dist.
28Cette fonction reçois en paramètre l'URL de callback
29
30Cette fonction doit renvoyer directement l'url de connexion.
31
32La balise #CONNECTEUR_*TYPE* est alors disponible et renverra l'URL de connexion via le provider.
33
34#### Callback
35
36Il est important que l'envoie du token d'accès ce fasse sur l'action **connexion** de SPIP, sans quoi le connecteur n'activera pas le reste de la procédure.
37L'URL de l'action connexion
38
39Cette action prend en paramètre le type de connexion à effectuer.
40
41### Inscription/connexion de l'auteur
42
43L'inscription de l'auteur dans la base de donnée ce fait via une fonction de récupération des informations.
44Cette fonction dois ce trouver dans un fichier *connecteur/*type*_info.php*
45Cette fonction  doit renvoyer un tableau au minimum une clé nom et une clé email :
46
47```php
48array('nom' => 'truc', 'email' => 'truc@machin.be')
49```
50
51L'action de connexion va alors créer l'auteur s'il n'existe pas et le connecter au site.
Note: See TracBrowser for help on using the repository browser.