La version Quince (novembre 2020) a introduit des Comptes de Service, qui permettent d'utiliser un utilisateur d'API et des droits dédiés. Par conséquent, il n'est plus possible de créer de nouvelles applications d'API ni de modifier des applications existantes via cette section API. Les applications existantes continueront de fonctionner et pourront toujours être consultées.
Pour utiliser une API, Selligent by Zeta nécessite la création d'une application (appli), qui génère des clés d'authentification et des clés secrètes pour l'interface avec l'API.
Les applications font partie de l'onglet Intégration des données dans la Configuration Admin 
L'aperçu des applications affiche toutes les applications configurées.
À partir cet aperçu, vous pouvez :
- Accéder une application existante — En cliquant sur le nom d'une application ou sur l'icône Visualiser. Les propriétés sont ensuite affichées dans une fenêtre coulissante sur la droite. Aucune modification ne peut être effectuée.
- Supprimer une application existante — En cliquant sur la corbeille.
Accéder une application permettant de visualiserles clés d'authentification de l'API
Quand vous accédez à l'application, les propriétés s'affichent dans une fenêtre coulissante sur la droite.
Le nom de l'application s'affiche.
La clé d'authentification et la clé secrète peuvent être utilisées au sein de l'API.
Le filtrage IP garantit que seuls les appels émanant d'adresses IP données sont pris en compte. Si un appel est effectué à partir de l’API d’une adresse IP différente, il ne sera pas pris en compte.
Vous pouvez aussi filtrer les Unités commerciales pouvant accéder à cette application.
Accéder à l'API
L'API est accessible à partir d'une URL dédiée liée à votre environnement. (par exemple http://VOTRE_ENVIRONNEMENT/Portal/Api/swagger/)
Au lancement de l'explorateur d'API, saisissez la clé et la clé secrète dans le coin supérieur droit. Vous pouvez désormais tester la méthode API.
Remarque: Toute la documentation concernant l'API et l'utilisation des méthodes se trouve directement dans l'explorateur d'API, accessible depuis l'entrée Modules de la barre d'outils.
Limites de débit d'API
Limites de débit
Une limite de débit définit le nombre de requêtes qui peuvent être adressées à l'API REST Selligent by Zeta au cours d'une période donnée. Si cette limite est dépassée sur une période, l'application est bridée et les requêtes d'API au-dessus de la limite sont rejetées.
Le bridage est lié à la configuration APP dans Selligent by Zeta et appliqué à sa clé d'API associée.
Limites de l'API pour l'API REST Selligent
Toutes les demandes d'API REST Selligent sont soumises à des limites de débit. Une clé d'API est autorisée à effectuer jusqu'à 2500 requêtes par minute sur tous les chemins d'API.
Remarque: Les limites d'API ne s'appliquent qu'à l'API REST Selligent. Les API REST Campaign et Direct Mail ne sont pas soumises à ces limites.
Réponses lorsque le nombre de requêtes est limité
Si les requêtes s'effectuent à un débit supérieur aux limites de :
- 2 500 requêtes / minute
Alors elles reçoivent le code de statut HTTP 429 (trop de requêtes), ainsi qu'un message, comme ci-dessous, dans le corps de la réponse.
Exemple: Le quota d'appels de l'API a été dépassé ! Le maximum autorisé est de 2 500 par minute.
Les en-têtes de réponse affichent des informations supplémentaires sur l'état de limitation de débit.
Exemple:
X-RateLimit-Limit: 2 500
X-RateLimit-Remaining: 50
X-RateLimit-Reset: 5
- X-RateLimit-Limit — représente le nombre maximum de requêtes autorisées sur la période
- X-RateLimit-Remaining — représente le nombre de requêtes restantes sur la période actuelle (1 minute)
- X-RateLimit-Reset — représente le temps restant sur la période actuelle, en secondes
Dans le cas où l'API REST Selligent by Zeta est sous forte charge ou en panne pour maintenance, le code de statut HTTP 503 (service non disponible) est renvoyé.
Limite de requêtes entrantes de l'API
La plupart des points de terminaison d'API ont des limites entrantes définies comme suit :
Limite de requêtes entrantes par défaut
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données doivent être postées et traitées dans les 15 secondes.
- La taille des données est limitée à 2 Mo.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Les points de terminaison « POST /data/load » prennent en charge des limites de requêtes entrantes plus élevées, selon le mode de transfert de données.
Il n'existe actuellement aucune contrainte de validation de quantité sur :
- Le nombre de champs par fiche.
- Le nombre total de fiches renvoyées.
Remarque: Le nombre de champs et le nombre de fiches sont limités par la taille de l'objet de données total.
Exemple: un nombre plus important de champs signifie un nombre moins important de fiches pouvant être soumises, et vice versa.
/data/load SYNC MODE
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données doivent être postées et traitées dans les 15 secondes.
- La taille des données est limitée à 20 Mo.
- Le nombre de champs de données n'est pas spécifiquement limité.
- Le nombre de fiches dépend du nombre de champs.
- Le taux par défaut est limité à 2 500 requêtes/minute.
/data/load STREAMED MODE
- Pas de limite de temps de connexion.
- Les données sont limitées à 20 Mo.
- Le nombre de champs de données n'est pas spécifiquement limité.
- Le nombre de fiches dépend du nombre de champs.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Limites de réponses sortantes de l'API
La limite de réponses est généralement basée sur la totalité des sorties de données et le temps nécessaire pour récupérer le jeu de données, qui se reflète dans le nombre de champs définis. Si le nombre de champs est bas, le résultat peut être plus élevé.
Limite de requêtes sortantes par défaut
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données sont requises et renvoyées dans les 15 secondes.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Les points de terminaison « POST /data/search » prennent en charge des limites de réponses sortantes plus élevées, selon le mode de transfert de données.
Il n'existe actuellement aucune contrainte sur :
- Le nombre de champs d'exportation.
- Le nombre de fiches.
MAIS la combinaison du nombre de champs et du nombre de fiches est limitée par la taille de l'objet de données total.
/data/search SYNC MODE
- Pas de limites de délai.
- Il est conseillé de limiter le nombre de fiches à un « résultat » de 2500.
- Les données sont limitées à un maximum de 1 Mo par fiche.
- Le taux par défaut est limité à 2 500 requêtes/minute.
/data/search STREAMED MODE
- Pas de limites de délai.
- Les données sont limitées à un maximum de 1 Mo par fiche.
- Le taux par défaut est limité à 2 500 requêtes/minute.
