Identification api

L'authentification à l'api se fait via des tokens générés avec vos identifiants coefficy.

Les tokens sont au format JSON Web Token.

Chaque token généré est associé à un refreshToken, qui permet de régénérer un token sans avoir a renvoyer ses identifiants quand celui-ci n'est plus valide.

Quand le token est régénérer il est remplacé par le nouveau.

Pour des raisons techniques, et seulement pendant un temps, les token et refreshToken ont une durée de vie de 1 an.

Dans le futur la durée de vie du token va être diminuée, le refreshToken quant à lui restera valide 1 an.

Identification API

Générer une clé api

POST https://api.campaign.coefficy.com/v1/login

Se connecter à l'api et générer une clé api pour l'utilisateur, les identifiants sont les mêmes que sur Coefficy

Request Body

Name	Type	Description
username*		l'identifiant de l'utilisateur
password*	String	Mot de passe de l'utilisateur

200: OK clé créée avec succès

{
    "success": true,
    "token": string,
    "tokenExpirationDate": datetime,
    "refreshToken": string,
    "refreshTokenExpirationDate": datetime
}

400: Bad Request Champs manquants

{
    "success": false
}

401: Unauthorized Identifiants incorrects

{
    "success": false
}

403: Forbidden Identification non autorisée

{
    "success": false
}

Régénérer la clé API via sa clé de rafraîchissement

POST https://api.campaign.coefficy.com/v1/refreshToken

Chaque clé créée a une durée de vie, on peut la rafraîchir via sa clé de rafraîchissement.

Request Body

Name	Type	Description
refreshToken*	String

200: OK clé régénérée

{
    "success": true,
    "parameters": {
        "refreshToken": string
    },
    "token": string,
    "tokenExpirationDate": datetime,
    "refreshToken": string,
    "refreshTokenExpirationDate": datetime
}

400: Bad Request Champs manquants

{
    "success": false
}

403: Forbidden Identification non autorisée

{
    "success": false
}

401: Unauthorized Identifiants incorrects

{
    "success": false
}

Supprimer une clé api

POST https://api.campaign.coefficy.com/v1/logout

Supprimer une clé supprime aussi sa clé de rafraîchissement

Headers

Name	Type	Description
x-access-token*	String	clé d'accès api

200: OK Clé supprimée avec succès

{
    "success": true,
    "parameters": {
        "token": string
    },
    "message":string
}

401: Unauthorized Clé invalide

{
    "success": false
}