Comment un agent utilise Anonify
Suivez ces étapes dans cet ordre. Ceci est l’API agent sur https://app.anonify.nl. Une personne peut aussi lire cette page.
1. Demandez si un compte existe déjà
Demandez à la personne si elle a déjà un compte Anonify.
Si oui, n’appelez pas signup. Passez l’étape nouveau compte et utilisez l’étape compte existant.
2. Nouveau compte
Si elle n’a pas de compte, POST https://app.anonify.nl/api/v1/auth/signup avec le JSON ci-dessous. Omettez password. N’ajoutez pas de champ password.
username ne contient que des lettres et des chiffres. Le serveur le stocke en minuscules. Il ne peut pas être modifié.
La réponse contient token, user et userKey. userKey est la clé d’API. Elle commence par ank_.
Le compte reçoit une entreprise nommée My company et un workspace nommé My workspace.
La première fois que la personne ouvre l’application, celle-ci demande de définir un mot de passe.
Si signup indique que l’e-mail existe déjà, arrêtez. Le message du serveur est "Username or Email already exists!". Ne vous inscrivez pas à nouveau. Demandez une clé et utilisez l’étape compte existant.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Compte existant
N’appelez pas signup.
La personne se connecte sur https://app.anonify.nl/login et crée une clé sur https://app.anonify.nl/profile, puis vous colle cette clé.
La clé commence par ank_. Une seule clé est active. Une nouvelle clé remplace l’ancienne.
Un 401 signifie que la clé est fausse ou révoquée. Demandez une nouvelle clé. Ne vous inscrivez pas à nouveau.
4. Envoyez la clé
Envoyez la clé sur chaque requête ci-dessous dans Authorization: Bearer ank_...
Utilisez userKey de signup, ou la clé collée par la personne. N’envoyez pas le token de signup dans cet en-tête.
Authorization: Bearer ank_...5. Lisez les workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. La réponse contient les workspaces auxquels cette clé a accès.
Un workspace est celui par défaut. Si la réponse contient un seul workspace, omettez workspaceId à l’envoi.
Si la réponse contient plus d’un workspace, l’envoi doit inclure cet id de workspace dans workspaceId. Demandez à la personne quel id utiliser.
Vous ne pouvez pas créer de workspace.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Envoyez le fichier
POST https://app.anonify.nl/api/v1/agent-actions/uploads en multipart form data.
Envoyez le champ file. PDF, PNG et JPEG sont acceptés.
Envoyez workspaceId seulement si cette clé a accès à plus d’un workspace.
La réponse est taskId et status.
Après cette réponse, donnez à la personne le lien de l’éditeur dans la dernière étape. N’attendez pas la fin du traitement.
POST https://app.anonify.nl/api/v1/agent-actions/uploads Authorization: Bearer ank_... Content-Type: multipart/form-data file: <PDF, PNG, or JPEG> workspaceId: <only when this key can access more than one workspace>7. Lisez le job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Remplacez {taskId} par le taskId de la réponse d’envoi.
La réponse contient status, pageCount et les éléments détectés.
Chaque élément a id, page, text et redact. Un élément a parfois aussi tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Acceptez ou refusez les éléments
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions avec les tableaux JSON accept et reject d’ids d’éléments.
Envoyez les deux tableaux. Au moins un id est requis, dans l’un ou l’autre tableau. L’autre tableau peut être vide.
Cela met à jour ces éléments et génère le fichier.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Téléchargez le PDF
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Une fois la génération réussie, la réponse est le PDF.
Avant cela, la réponse est du JSON avec status. Ce n’est pas un fichier vide. N’enregistrez pas ce JSON comme PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Lisez la limite de pages
GET https://app.anonify.nl/api/v1/agent-actions/limits. La réponse contient pagesLeft.
Ne lancez pas de checkout. Ne payez pas.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Donnez l’éditeur à la personne
Après l’envoi, donnez à la personne https://app.anonify.nl/edit/{taskId}. Remplacez {taskId} par le taskId de la réponse d’envoi.
Pour connecter ce navigateur, ajoutez un hash avec token et user de la réponse signup. user est le JSON base64url de l’objet user.
Construisez le hash avec URLSearchParams. Les noms des paramètres sont token et user. base64url signifie JSON UTF-8, puis base64, puis remplacez + par -, / par _, et retirez le padding =.
L’éditeur reste fermé et affiche la barre de progression de l’envoi pendant le traitement du document. Ensuite il se charge tout seul.
Vous n’avez token et user qu’après signup. Pour un compte existant, donnez https://app.anonify.nl/edit/{taskId} sans hash. La personne se connecte avec son propre login.
N’appelez pas les routes React /media ou /tasks.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Ne faites pas ceci
- Ne listez pas les documents d’un workspace.
- Ne payez pas, et ne lancez pas de checkout.
- N’invitez personne.
- Ne supprimez rien.
- Ne renommez pas l’entreprise.
- Ne créez pas de workspace.
- N’appelez pas les routes React /media ou /tasks.
- N’appelez pas signup si la personne a déjà un compte, si signup indique que l’e-mail existe déjà, ou si une requête renvoie 401.