Aperçu

Parseur : tâches de collecte et travailleurs

Le parseur collecte des données, à partir desquelles une base de contacts de campagne est ensuite créée. Il est publié uniquement dans la version v1 — dans v2 ces opérations n'existent pas.

Le travail est divisé en trois parties : les tâches de collecte, les comptes système au nom desquels la collecte se fait, et les travailleurs qui l'exécutent.

Tâches de collecte#

GET/v1/parser/tasks

Liste des tâches de collecte.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

POST/v1/parser/tasks

Créer une tâche de collecte. Le corps de la demande est en JSON.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

GET/v1/parser/tasks/{task_id}

État de la tâche de collecte.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
task_idstringrequis

UUID de la tâche

POST/v1/parser/tasks/{task_id}/cancel

Annuler une tâche en cours d'exécution.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
task_idstringrequis

UUID de la tâche

GET/v1/parser/tasks/{task_id}/export

Exporter le résultat de la tâche.

Autorisation
Authorizationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
task_idstringrequis

UUID de la tâche

DELETE/v1/parser/tasks/{task_id}

Supprimer la tâche ainsi que son résultat.

Autorisation
Authorizationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
task_idstringrequis

UUID de la tâche

POST/v1/parser/entity-checks

Créer une vérification d'entité. Le corps de la requête est en JSON.

Autorisation
Authorizationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Comptes système#

Les comptes système sont des comptes distincts sous lesquels le parseur fonctionne. Ils se connectent avec une session d'autorisation propre, configurée de la même manière qu'une connexion de compte ordinaire : code, mot de passe cloud si nécessaire.

GET/v1/parser/system-accounts

Liste des comptes système du parseur.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

GET/v1/parser/system-accounts/{account_id}

Fiche du compte système.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
account_idstringrequis

UUID du compte système

DELETE/v1/parser/system-accounts/{account_id}

Désactiver le compte système.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
account_idstringrequis

UUID du compte système

POST/v1/parser/system-accounts/auth-sessions

Ouvrir une session d'autorisation pour le compte système. Le corps de la requête est en JSON.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

GET/v1/parser/system-accounts/auth-sessions/{auth_id}

État de la session d'authentification.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
auth_idstringrequis

UUID de la session

POST/v1/parser/system-accounts/auth-sessions/{auth_id}/code

Envoyer le code de confirmation. Le corps de la demande est en JSON.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
auth_idstringrequis

UUID de la session

POST/v1/parser/system-accounts/auth-sessions/{auth_id}/password

Envoyer le mot de passe cloud lors de la protection à deux facteurs. Le corps de la demande est en JSON.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
auth_idstringrequis

UUID de la session

DELETE/v1/parser/system-accounts/auth-sessions/{auth_id}

Interrompre une session inachevée.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
auth_idstringrequis

UUID de session

Travailleurs#

GET/v1/parser/workers

Liste des travailleurs du parseur et leur état.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

GET/v1/parser/workers/{node_name}

État d'un travailleur.

Autorisation
Autorisationstring

Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.

Chemin
node_namestringrequis

Nom du nœud du travailleur

Suite#

Updated

Parseur : tâches de collecte et travailleurs — NN Agent