Cómo usa un agente Anonify
Siga estos pasos en este orden. Esta es la API de agente en https://app.anonify.nl. Una persona también puede leer esta página.
1. Pregunte si ya existe una cuenta
Pregunte a la persona si ya tiene una cuenta de Anonify.
Si la tiene, no llame a signup. Salte el paso de cuenta nueva y use el paso de cuenta existente.
2. Cuenta nueva
Si no tiene cuenta, POST https://app.anonify.nl/api/v1/auth/signup con el JSON de abajo. Omita password. No añada un campo password.
username solo tiene letras y números. El servidor lo guarda en minúsculas. No se puede cambiar.
La respuesta incluye token, user y userKey. userKey es la clave de API. Empieza por ank_.
La cuenta recibe una empresa llamada My company y un workspace llamado My workspace.
La primera vez que la persona abre la aplicación, esta pide definir una contraseña.
Si signup dice que el correo ya existe, pare. El mensaje del servidor es "Username or Email already exists!". No se registre otra vez. Pida una clave y use el paso de cuenta existente.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Cuenta existente
No llame a signup.
La persona inicia sesión en https://app.anonify.nl/login y crea una clave en https://app.anonify.nl/profile, y luego le pega esa clave.
La clave empieza por ank_. Hay una clave activa. Una clave nueva sustituye a la anterior.
Un 401 significa que la clave es incorrecta o está revocada. Pida una clave nueva. No se registre otra vez.
4. Envíe la clave
Envíe la clave en cada petición de abajo como Authorization: Bearer ank_...
Use userKey de signup, o la clave que la persona pegó. No envíe el token de signup en esta cabecera.
Authorization: Bearer ank_...5. Lea los workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. La respuesta son los workspaces a los que esta clave puede acceder.
Un workspace es el predeterminado. Si la respuesta contiene un workspace, omita workspaceId en la subida.
Si la respuesta contiene más de un workspace, la subida debe incluir ese id de workspace como workspaceId. Pregunte a la persona qué id usar.
No puede crear un workspace.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Suba el archivo
POST https://app.anonify.nl/api/v1/agent-actions/uploads como multipart form data.
Envíe el campo file. Se aceptan PDF, PNG y JPEG.
Envíe workspaceId solo cuando esta clave puede acceder a más de un workspace.
La respuesta es taskId y status.
Después de esta respuesta, dé a la persona el enlace del editor en el último paso. No espere a que termine el proceso.
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. Lea el job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Sustituya {taskId} por el taskId de la respuesta de subida.
La respuesta incluye status, pageCount y los elementos detectados.
Cada elemento tiene id, page, text y redact. Un elemento a veces también tiene tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Acepte o rechace elementos
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions con los arrays JSON accept y reject de ids de elementos.
Envíe ambos arrays. Hace falta al menos un id, en cualquiera de los dos arrays. El otro array puede estar vacío.
Esto actualiza esos elementos y genera el archivo.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Descargue el PDF
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Cuando la generación termina bien, la respuesta es el PDF.
Antes de eso, la respuesta es JSON con status. No es un archivo vacío. No guarde ese JSON como PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Lea el límite de páginas
GET https://app.anonify.nl/api/v1/agent-actions/limits. La respuesta incluye pagesLeft.
No inicie un checkout. No pague.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Dé el editor a la persona
Después de la subida, dé a la persona https://app.anonify.nl/edit/{taskId}. Sustituya {taskId} por el taskId de la respuesta de subida.
Para iniciar sesión en ese navegador, añada un hash con token y user de la respuesta de signup. user es el JSON en base64url del objeto user.
Construya el hash con URLSearchParams. Los nombres de los parámetros son token y user. base64url significa JSON UTF-8, luego base64, luego sustituya + por -, / por _, y quite el relleno =.
El editor permanece cerrado y muestra la barra de progreso de la subida mientras el documento se procesa. Después se carga solo.
Solo tiene token y user tras signup. Para una cuenta existente, dé https://app.anonify.nl/edit/{taskId} sin hash. La persona inicia sesión con su propio acceso.
No llame a las rutas React /media o /tasks.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
No haga esto
- No liste documentos de un workspace.
- No pague y no inicie un checkout.
- No invite a nadie.
- No borre nada.
- No cambie el nombre de la empresa.
- No cree un workspace.
- No llame a las rutas React /media o /tasks.
- No llame a signup si la persona ya tiene una cuenta, si signup dice que el correo ya existe, o si una petición devuelve 401.