L'API REST vous permet d'interagir programmatiquement avec quarksUp, vous pouvez utiliser cette API pour construire vos propres applications ou simplement extraire les données qui vous intéressent.
\nVous trouverez dans cette documentation le détail des ressources REST disponibles ainsi que des exemples d'utilisation.
\nSi vous ne connaissez pas l'url de votre api merci de vous rapprocher de votre consultant quarksUp.
\nL'url des apis quarksUp dépend de l'environnement sur lequel vous requêtez :
\nproduction : https://service-tenant.quarksup.net/api/v2\nstaging : https://service-tenant-staging.quarksup.net/api/v2\ntraining : {{api-url-training}}/api/v2\nLa version est à indiquer directement dans un segment de l'url comme suit :
\nhttps://service-tenant.quarksup.net/api/v2\nTrois types d'authentification sont supportées par l'api:
\nIl est nécessaire de spécifier l'entête Authorization en settant sa valeur avec le Bearer token généré par l'IDP.
\nLors de l'utilisation du Client Credentials Grant flow, il est possible d'indiquer à l'API sur quel espace la requête est à exécuter en spécifiant le paramètre \"spaceId\" dans la query. Ce paramètre permet de contextualiser la requête en terme de données à traiter.
\nLes endpoints situés dans des routes \"public\" sont accessibles de manière basique en précisant simplement une clé d'api dans l'entête de requête, utiliser l'entête \"api-key\" pour préciser la clé.
\nSi vous ne possédez pas de clé d'api ou si vous cherchez à vous authentifier en Credentials Grant Flow merci de vous rapprocher de votre consultant quarksUp.
\nDes URL présignées sont également utilisées ; elles ne requièrent aucune authentification mais expirent rapidement.
\nrequired sont des champs requisrestricted sont des champs soumis à permissionsversatile sont des champs capables de gérer un id ou un libellé (spécifier et l'id et le libellé n'est pas autorisé). Dans le cas ou le libellé est spécifié, l'api se charge de vérifier si un élément ayant le même libellé existe déjà dans l'orgnisation et si tel est le cas elle attribue automatique son id à l'élément soumis dans la requêteenum sont des champs ayant des valeurs prédéfinies immuables[,] indiquent qu'une saisie d'une liste de valeurs séprarées par une virgule est autoriséeprefer est spécifiable sur certains endpoints PATCH/PUT, l'indiquer permettra d'obtenir en retour de requête l'objet nouvellement modifié (return=minimal pour un fragment d'objet et return=representation pour l'objet complet).\n\nNote : par défaut, les retours sont formattés en JSON.
\n
En cas de succès les codes suivant sont retournés :
\nEn cas d'erreur les codes suivant seront retournés :
\nLes erreurs sont retournées dans le format suivant :
\n{ \n \"status\": \"UnprocessableEntity\", \n \"code\": 422, \n \"errors\": \n [ \n {\n \"field\": \"login\", \n \"message\": \"Le login existe déjà.\" \n } \n ] \n}\n\n\nNote : les messages renvoyés sont directement dans la locale d'appel
\n
Il est possible de regrouper plusieurs requêtes en une seule, pour cela il convient d'utiliser un type de contenu spécifique \"multipart/mixed; boundary=\".
\nUrl
\nhttps://service-tenant.quarksup.net/api/$batch\nEntête
\nmultipart/mixed; boundary=\"api_request\"\nCorps
\n--api_request\nContent-Type: application/http; msgtype=request\n\nGET /api/v2/recruitment/candidates/10341?locale=fr-fr HTTP/1.1\nHost: {api-url}\n\n\n--api_request\nContent-Type: application/http; msgtype=request\n\nGET /api/v2/people/companies/2?locale=fr-fr HTTP/1.1\nHost: {api-url}\n\n\n--api_request--\n\n\nNote : le formattage de la requête est important, les sauts de lignes et espacements sont à respecter. Nous recommandons de ne pas batcher plus de 10 appels à la fois. Le batching imbriqué est interdit.
\n
La majorité des endpoints pouvant renvoyer une grosse volumétrie de données, une pagination des retours est en place. Par défaut, le maximum d'éléments autorisé par page est retourné par l'api.
\nLa pagination est modifiable en utilisant 2 paramètres de query :
\nskip - Nombre d'éléments à ignorer
\ntop - Nombre d'éléments à renvoyer
\n\n\nNote : la valeur par défaut est de 100 pour les endpoints métiers classiques (valeur maximale autorisée 500) et de 1000 pour les endpoints de type reports (valeur maximale autorisée 2000). Toute valeur supérieure aux valeurs maximales autorisées sera ignorée, aucune erreur ne sera générée.
\n
Il est recommandé de préciser le paramètre top de manière à ce que le comportement des applications clientes ne change pas si ces limites étaient amenées à évoluer.
\nPour éviter que l'api ne soit submergée par un trop grand nombre de requêtes, les limites d'appel suivantes sont en place :
\n\n\nNote: Si l'api retourne un code 429, vérifier l'entête Retry-After pour obtenir le nombre de secondes à attendre avant de renouveler l'appel.
\n
Les endpoints de type \"Query\" sont des endpoints Odata avec le paramétrage suivant :
\nUn workflow est la représentation d'une suite de tâches aboutissant à la réalisation d'un processus métier. Les workflows quarksUp sont paramétrables par statut de ressource, groupe de rôle et espace, la combinaison de ces éléments se nomme une \"sequence\".
\nLes ressources supportant les workflows exposent des endpoints spécifiques qui permettent d'obtenir :
\nLes ressources supportant l'envoi d'emails exposent des endpoints spécifiques qui permettent :
\nLes ressources supportant la fusion avec des modèles de documents exposent un endpoint spécifique qui permet :
\nGénère un access token pour un client de confiance.
\nPour utiliser ce mode d'authentification vous devez obtenir de votre consultant quarksUp les informations nécessaires :
\nSi vous utilisez Postman vous pourrez paramétrer ces variables au niveau de la collection et de l'environnement sélectionné (Production ou Staging) et simplement exécuter la requête pour être authentifié et placer le token automatiquement en variable utilisable sur les requêtes suivantes.
\n","urlObject":{"path":["oauth2","token"],"host":["https://login.quarksup.net/adfs"],"query":[],"variable":[]}},"response":[],"_postman_id":"566883fd-dcfe-4ea1-aeba-154e1353d4d7"}],"id":"d2c97d20-b574-4ab7-a4c3-dc3525737297","_postman_id":"d2c97d20-b574-4ab7-a4c3-dc3525737297","description":""},{"name":"Gets the instance information.","id":"b98472ef-b540-4800-a4a0-e9659ac1bb45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://service-tenant.quarksup.net/api/v2/organization/info","description":"Retourne les détails de paramétrage de l'instance.
\n","urlObject":{"path":["api","v2","organization","info"],"host":["https://service-tenant.quarksup.net"],"query":[],"variable":[]}},"response":[{"id":"5ace8682-c037-47c1-b736-b25c2207e486","name":"Gets the instance information","originalRequest":{"method":"GET","header":[],"url":"https://service-tenant.quarksup.net/api/v2/organization/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tenant\": \"