sous-page-bg

Documentation de l'API REST

Toutes les fonctionnalités disponibles via la page Web et l'interface utilisateur peuvent également être utilisées via l'API REST
La documentation complète sur Swagger est disponible ici

Authentification

Pour effectuer une requête, vous devez d'abord récupérer le jeton :

POST https://api.wachete.com/thirdparty/v1/user/apilogin Content-type: application/json { "userId": "54c84df2-4432.....Get_from_profile", "apiKey": "fe69a46a82d542a7a....Get_from_profile" } response: { "token": "QSQ26DJM2HPAD4NP4MSAVZGH5FUJGNYZY498XDP9AFLDT95PZJQFKVVFZ35FU3BVU..." }

Créer un nouveau moniteur ou mettre à jour un moniteur existant

Moniteur simple

PUT https://api.wachete.com/thirdparty/v1/task Content-type: application/json Authorization:bearer QWQQQQUW3... { "id": "do_not_specify_if_creating_but_only_when_updating_existing_wachet" "name": "My First Monitor", "url": "http://www.mypage.com", "xPath": "/", "jobType": "SinglePage", # OPTIONAL - Default SinglePage "alerts": [{ "type": "Error" }, { type: "NotEq" }], "recurrenceInSeconds": 86400, "notificationEndpoints": [{ # OPTIONAL - Default all endpoints "type": "Webhook", "value": "https://..." }, { "type": "Email", "value": "email@gmail.com" } ] }

Moniteur de la porte

PUT https://api.wachete.com/thirdparty/v1/task Content-type: application/json Authorization:bearer QWQQQQUW3... { "id": "do_not_specify_if_creating_but_only_when_changing_existing_wachet" "name": "My First Monitor", "url": "http://www.mypage.com", "xPath": "/", "jobType": "Portal", "crawlingDepth": 2, # OPTIONAL - Default is 2 "urlFilter": { # OPTIONAL - Default no filters "include": [{ "filter" : "http://products/catalog/", "type" : "Contains" }], "exclude": [{ "filter" : "cars[0-9]+", "type" : "Regex" }] } "alerts": [{ "type": "Error" }, { type: "NotEq" }], "recurrenceInSeconds": 86400, "notificationEndpoints": [{ # OPTIONAL - Default all endpoints "type": "Webhook", "value": "https://..." }, { "type": "Email", "value": "email@gmail.com" } ] }

jobType - use 'SinglePage' or 'Portal' for crawling
notificationEndpoints - Leave empty to receive notification to all emails by default
proxies - For monitoring from location using proxy use - [{"location": "location"}] - location can be us,gb
dynamicContent - in case your page content which you monitor is rendered with javascript specify - true
crawlingDepth - If you chose jobType 'Portal', automatic crawling, you can specify how deep to crawl. Possible values - 1,2,3
urlFilter - Used for Portal monitor to filter URLs either by simple contains string or by regular expression

Obtenir les informations et les paramètres de base de l'écran

GET https://api.wachete.com/thirdparty/v1/task/{taskId} Content-type: application/json Authorization:bearer QWQQQQUW3...

taskId: spécifier l'ID du moniteur

Recevoir des notifications

GET https://api.wachete.com/thirdparty/v1/notification/list Content-type: application/json Authorization:bearer QWQQQQUW3...

taskId: permet de n'afficher que les notifications provenant d'un seul moniteur, identifié par son ID. Si ce paramètre n'est pas spécifié, toutes les notifications sont affichées. (paramètre de requête)
from: permet de spécifier (facultatif) la plage horaire de départ (FROM) des notifications au format ISO (paramètre de requête)
to: permet de spécifier (facultatif) la plage horaire de fin (TO) des notifications au format ISO (paramètre de requête)

Récupérer les valeurs de contenu du moniteur

GET https://api.wachete.com/thirdparty/v1/data/list/{ID_OF_YOUR_WACHET} Content-type: application/json Authorization:bearer QWQQQQUW3...

returnDiff - indiquez ceci comme suit : vrai si vous souhaitez obtenir « google diff » (paramètre de requête) au lieu de simples valeurs
jeton de poursuite - pour récupérer la série suivante de données (paramètre de requête)
de - indiquer éventuellement, au format ISO, l'heure « FROM » pour les notifications (paramètre de requête)
à - indiquer éventuellement, au format ISO, l'heure de réception des notifications (paramètre de requête)

Supprimer le moniteur

DELETE https://api.wachete.com/thirdparty/v1/task/{ID_OF_YOUR_WACHET} Content-type: application/json Authorization:bearer QWQQQQUW3...

Récupérer le contenu d'un dossier

GET https://api.wachete.com/thirdparty/v1/folder/list Content-type: application/json Authorization:bearer QWQQQQUW3...

parentId: à indiquer pour afficher le contenu d'un dossier dont l'ID est spécifié. Si ce paramètre n'est pas fourni, le répertoire racine est affiché. (paramètre de requête)