AuthAccess

Présentation  

Cet objet gère l'authentification ainsi que les autorisations lors d'une interaction entre votre système et le notre. Pour l'instant, il est possible de définir sur cet objet les autorisations suivantes:

•   money-in-only : Seules les requêtes d'API permettant d'ajouter de l'argent sur votre compte peuvent etre faite avec cet objet AuthAccess.
•   read-only : Seules les requêtes d'API en lecture pourront être éffectuées avec cet objet AuthAccess. Il sera par exemple possible de recupérer programmatiquement la liste des transactions et impossible de transferer de l'argent ou de créer un nouvel objet AuthAccess.
•   read/money-in : Seules les requêtes d'API en lecture ainsi que les requêtes d'API permettant d'ajouter de l'argent sur votre compte peuvent etre faite avec cet objet AuthAccess.
•   read-write/no-money-out : Les requêtes d'API en lecture ou en écriture peuvent être faites mais il ne sera pas possible de transférer de l'argent depuis votre compte vers l'extérieur. Notez qu'il sera également impossible de créer un AuthAccess qui permettra de transférer de l'argent depuis votre compte.
•   full-access : Toutes les requêtes d'API possibles sur votre compte pourront être éffectuées avec cet objet

Opérations  

create  

Créer un nouvel objet AuthAccess et retourne l'objet nouvellement créé.
Cette opération prend en entrée les paramètres suivants:

name
Obligatoire

string
Nom de cette clé d'authentification

permission
Obligatoire

string
Il est possible d'exprimer les permissions soit de manière simple ou alors de manière complexe avec un haut degré de control sur les droits des clé d'API.
Pour l'instant, il vous est possible d'utiliser le format simple uniquement, les autres possibilités viendront dans une mise à jour ultérieure.

Les seules valeurs possibles sont: "FullAccess"  "MoneyInOnly"  "ReadMoneyIn"  "ReadOnly"  "ReadWriteNoMoneyOut"  

description

string | undefined
Détails, explications, annotations concernant cet objet pour mieux vous organiser et vous retrouvez plus tard.

foreignData

string | undefined
Données qui vous sont propres que vous pouvez attacher à l'objet créé. Il peut s'agir de données de type JSON XML, d'autres format de données ou simplement des Strings.
La longueur maximale autorisée est de 255 caractères.

foreignId

string | undefined
ID Personalisé ou bien ID de votre système interne que vous souhaitez attacher à cet objet pour vous permettre de le récupérer plus tard.
Une fois créée, cette valeur est non modifiable.
Cette valeur doit être unique pour chaque type.
La longueur maximale autorisée est de 128 caractères.

Voici un exemple de code pour éffectuer une création d'un objet AuthAccess:

const authAccessPromise = 
    fPay.authAccess.create({
        name: "API Keys for CRM developers",
        permission: "ReadWriteNoMoneyOut",
        description: "My description",
        foreignData: "{\"myKey\": 19, \"myOtherKey\": \"myOtherValue\"}",
        foreignId: "123456789"
    });

get  

Retourne un objet AuthAccess identifié par un identifiant.
Vous avez la possibilité d'utiliser un ID unique propre à votre système. Pour utiliser votre propre ID au lieu de celui généré par FPay, vous devez préciser le champ foreignId lors de la création de cet objet. Ainsi, vous pourrez récupérer cet objet par le champ foreignId ainsi ajouté qui doit être unique pour tous les objets de type AuthAccess.  Voici tous les champs dont les valeurs peuvent servir d'identifiant pour cette opération:

• id
• token
• foreignId

const authAccessPromise = fPay.authAccess.get("identifier");

list  

Retourne une collection d'objets AuthAccess éventuellement filtrée et/ou triée. Voici les paramètres supportés par cette opération.

Voici quelques exemples de code pour éffectuer un listing afin de retourner une collection d'objets AuthAccess:

const authAccessCollectionPromise = fPay.authAccess.listAll();

const authAccessCollectionPromise = 
    fPay.authAccess.list({
        sortBy: "id:ASC"
    });

const authAccessCollectionPromise = 
    fPay.authAccess.list({
        limit: 5
    });

const authAccessCollectionPromise = 
    fPay.authAccess.list({
        filter: "id in {'31234', '5678', '9990'}"
    });

const authAccessCollectionPromise = 
    fPay.authAccess.list({
        filter: "createdTime isBefore Yesterday",
        sortBy: "foreignId:DESC"
    });

const authAccessCollectionPromise = 
    fPay.authAccess.list({
        filter: "id startsWith abcd",
        sortBy: "createdTime:ASC",
        limit: 25
    });

fetchPage  

Lorsque vous récupérez une liste de AuthAccess, les résultats retournés par le serveur peuvent être paginés c'est dire que ces résultats seront disposés sur plusieurs pages. Cette fonction fetchPage permet de naviguer de page en page afin d'itérer sur tous les éléments. Par conséquent cette fonction retourne une collection de AuthAccess.

Imaginons que vous ayez récupéré une collection de AuthAccessavec le code suivant:

const authAccessCollectionPromise = fPay.authAccess.listAll();

Si jamais le resultat est disposé sur plusieurs pages, pour consulter la page suivante, vous devez faire:

authAccessCollectionPromise.then(authAccessCollection => {
    if(authAccessCollection.hasNextPage()) {
        const nextAuthAccessPromise = fPay.authAccess.fetchPage(authAccessCollection.pagination.nextPage);
    }
});

update  

Modifie un objet AuthAccess et retourne la version modifiée de celui ci.
 Voici tous les champs dont les valeurs peuvent servir d'identifiant pour cette opération:

• id
• token
• foreignId

Voici quelques exemples de code pour éffectuer une modification:

authAccessPromise = 
    fPay.authAccess.update({
         id: "<id | foreignId>",
         change: {
            description: "<new value>",
            foreignData: "<new value>"
         }
    });

authAccessPromise = 
    fPay.authAccess.update({
         id: "<id | foreignId>",
         change: {
            description: "<new value>"
         },
         'remove': ['foreignData']
    });

authAccessPromise = 
    fPay.authAccess.update({
         id: "<id | foreignId>",
         'remove': ['description', 'foreignData']
    });

Liste Filtre & Tri  

Champs  

Lorsque vous récupérez une liste, voici les champs par lesquels il est possible de faire des filtres ainsi que des tris.

Exemples de Code  

Des exemples de code sont disponibles sur la page Audit Reporting & Tableau de bord.

Champs  

createdTime

UTCDateTime
Date et heure auxquelles cet objet a été créé. Valeur toujours stockée en UTC (Temps universel), ce champ contient une representation de cet instant au format ISO 8601 ainsi qu'une representation de ce même instant en timestamp secondes et millisecondes.

iso8601

string
Date et heure au format ISO 8601

timestamp

Timestamp

milliseconds

number
Date et heure exprimées en Timestamp milli secondes

seconds

Double
Date et heure exprimées en Timestamp secondes

creator

Creator

Creator.Api
Api

_type

string

La seule valeur possible est: "Api"  

accountId

string

authAccessId

string

Creator.Ui
Ui

_type

string

La seule valeur possible est: "Ui"  

accountId

string

personId

string

description

string | undefined
Détails, explications, annotations concernant cet objet pour mieux vous organiser et vous retrouvez plus tard.

foreignData

string | undefined
Données qui vous sont propres que vous pouvez attacher à l'objet créé. Il peut s'agir de données de type JSON XML, d'autres format de données ou simplement des Strings.
La longueur maximale autorisée est de 255 caractères.

foreignId

string | undefined
ID Personalisé ou bien ID de votre système interne que vous souhaitez attacher à cet objet pour vous permettre de le récupérer plus tard.
Une fois créée, cette valeur est non modifiable.
Cette valeur doit être unique pour chaque type.
La longueur maximale autorisée est de 128 caractères.

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

isEnabled

boolean
Indique si cette clé d'API est active et peut donc faire des requêtes vers les serveurs de FPay.
L'activation et la désactivation se font uniquement à partir de votre console  et ne sont donc pas possible depuis les APIs.

name

string

permission

AuthAccessPermission
Il est possible d'exprimer les permissions soit de manière simple ou alors de manière complexe avec un haut degré de control sur les droits des clé d'API.
Pour l'instant, il vous est possible d'utiliser le format simple uniquement, les autres possibilités viendront dans une mise à jour ultérieure.

AuthAccessPermission.Complex
Complex

_type

string

La seule valeur possible est: "Complex"  

AuthAccessPermission.Simple
Simple

_type

string

La seule valeur possible est: "Simple"  

name

string

Les seules valeurs possibles sont: "FullAccess"  "MoneyInOnly"  "ReadMoneyIn"  "ReadOnly"  "ReadWriteNoMoneyOut"  

secretKey

string
Clé sécrete qui permet l'authentification et l'autorisation de vos requêtes avec les serveurs de FPay.
La valeur de ce champ est masquée lors de tout appel avec les APIs.

Important
Le champ secretKey de l'objet AuthAccess doit voir sa valeur absolument tenue sécrète et utilisée sur vos serveurs uniquement. Il ne sera jamais transmis lors des échanges avec les server-urs de FPay.
Garder cette valeur secrète à votre niveau implique notamment de ne jamais utiliser la valeur de ce champ comme valeur de variable ou de constante dans le code source d'une application mobile, d'une application web ou dans le code source de toute application dont le binaire pourra être public et visible à tous. Il existe de nombreux outils permettent d'accéder aux chaines de caractères présentes dans le code source à partir d'un binaire. 

token

string
Identifiant qui permet l'authentification et l'autorisation de vos requêtes avec les serveurs de FPay.

url

string
URL sur laquelle une methode GET convenablement autorisée renverra l'instance de l'objet sur lequel ce champ est défini.