METHODE 1 : AUTHENTIFICATION VIA L'API KEY
La première methode consiste à la création d'un serveur intermédiaire
Ce serveur vous appartient et vous devez le sécuriser, simple crm ne peut être tenu responsable de ce qui s'y passe.
ETAPE À SUIVRE :
- Créer une page qui gerera le token , par exemple token.php
- Créer ensuite une seconde page, la page que vos clients afficheront, par exemple societe_liste.php
- La page societe_liste.php va interroger la page token.php afin de recuperer le token .
- La page token.php demande un token à l'api.
- L'api retourne un token valide si l'apikey fournie est correcte
- La page token.php retourne le token valide si l'apikey enregistrée est correcte, si pas un message d'erreur ou autre.
- La page societe_list.php demande la liste des sociétés avec le token qu'elle vient de recevoir.
CAS D'UTILISATION
Cette methode sera utilisée si vous voulez donner un accès a des informations contenues dans l'api simple CRM SANS que le client puisse connaitre des informations de connection ou l'api key
L'api key ne doit en aucun cas être transmis ou partagé !
|
URLS DISPONIBLES
MÉTHODE |
URL
|
POST |
/auth |
L'unique url de recuperation de token via apikey. |
CHAMPS REQUIS
NOM |
DESCRIPTION |
apikey |
L'api key du compte utilisé pour chercher les informations |
RÉSULTAT
Exemple de résultat lors d'un retour positif
|
{
result : 1,
nickname : 'nom de l'utilisateur',
id : 'id de l'utilisateur',
instance : 'l'instance de l'utilisateur,
token : 'le token de l'utilisateur'
}
Exemple de résultat lors d'une erreur liée à la méthode. Les autres erreurs sont listées dans la section 'Erreurs'
|
{
result : 0,
err_code : 'CODE ERREUR',
err_message : 'Message error'
}
CODE D'ERREUR
Liste des erreurs possibles
|
CODE |
MESSAGE |
APIKEY_NO_EXIST
|
L'APIKEY passé en paramètre n'existe pas.
|
METHODE 2 : AUTHENTIFICATION VIA IDENTIFIANT ET MOT DE PASSE
La seconde methode consiste à utiliser les informations de connection à simple CRM
Cette methode sera utilisée si vous voulez authentifier un utilisateur enregistré dans votre simple CRM
|
CAS D'UTILISATION
Cette methode sera utilisée si vous voulez donner un accès a des informations contenues dans l'api simple CRM SANS que le client puisse connaitre des informations de connection ou l'api key
L'api key ne doit en aucun cas être transmis ou partagé !
|
URLS DISPONIBLES
MÉTHODE |
URL
|
POST |
/authentification |
L'url de recuperation de token via identifiant et mot de passe. |
CHAMPS REQUIS
NOM |
DESCRIPTION |
identifiant
|
L'identifiant du compte à authentifier
|
motdepasse
|
Le mot de passe du compte à authentifier
|
RÉSULTAT
Exemple de résultat lors d'un retour positif
|
{
result : 1,
nickname : 'nom de l'utilisateur',
id : 'id de l'utilisateur',
instance : 'l'instance de l'utilisateur,
token : 'le token de l'utilisateur'
}
CODE D'ERREUR
Liste des erreurs possibles
|
CODE |
MESSAGE |
PDO_SELECT_ERROR_NOT_RESULT
|
Aucun utilisateur avec cet identifiant et mot de passe.
|
|