So verwendet ein Agent Anonify
Folge diesen Schritten in dieser Reihenfolge. Dies ist die Agent-API auf https://app.anonify.nl. Eine Person kann diese Seite ebenfalls lesen.
1. Frage, ob schon ein Konto besteht
Frage die Person, ob sie schon ein Anonify-Konto hat.
Wenn ja, rufe signup nicht auf. Überspringe den Schritt für ein neues Konto und verwende den Schritt für ein bestehendes Konto.
2. Neues Konto
Wenn sie kein Konto hat, sende POST https://app.anonify.nl/api/v1/auth/signup mit dem JSON unten. Lass password weg. Füge kein password-Feld hinzu.
username enthält nur Buchstaben und Ziffern. Der Server speichert ihn in Kleinbuchstaben. Er kann nicht geändert werden.
Die Antwort enthält token, user und userKey. userKey ist der API-Schlüssel. Er beginnt mit ank_.
Das Konto erhält ein Unternehmen namens My company und einen Workspace namens My workspace.
Wenn die Person die App zum ersten Mal öffnet, fordert sie ein Passwort an.
Wenn signup sagt, dass die E-Mail schon existiert, stoppe. Die Servermeldung lautet "Username or Email already exists!". Registriere nicht erneut. Bitte um einen Schlüssel und verwende den Schritt für ein bestehendes Konto.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Bestehendes Konto
Rufe signup nicht auf.
Die Person meldet sich unter https://app.anonify.nl/login an und erstellt einen Schlüssel unter https://app.anonify.nl/profile, und fügt diesen Schlüssel dann bei dir ein.
Der Schlüssel beginnt mit ank_. Ein Schlüssel ist aktiv. Ein neuer Schlüssel ersetzt den alten.
Ein 401 bedeutet, dass der Schlüssel falsch oder widerrufen ist. Bitte um einen neuen Schlüssel. Registriere nicht erneut.
4. Sende den Schlüssel
Sende den Schlüssel bei jeder Anfrage unten als Authorization: Bearer ank_...
Verwende userKey aus signup oder den Schlüssel, den die Person eingefügt hat. Sende das signup-token nicht in diesem Header.
Authorization: Bearer ank_...5. Lies die Workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. Die Antwort sind die Workspaces, auf die dieser Schlüssel zugreifen kann.
Ein Workspace ist der Standard. Wenn die Antwort einen Workspace enthält, lass workspaceId beim Upload weg.
Wenn die Antwort mehr als einen Workspace enthält, muss der Upload diese Workspace-Id als workspaceId senden. Frage die Person, welche Id du verwenden sollst.
Du kannst keinen Workspace anlegen.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Lade die Datei hoch
POST https://app.anonify.nl/api/v1/agent-actions/uploads als multipart form data.
Sende das Feld file. PDF, PNG und JPEG werden akzeptiert.
Sende workspaceId nur, wenn dieser Schlüssel auf mehr als einen Workspace zugreifen kann.
Die Antwort ist taskId und status.
Gib der Person nach dieser Antwort den Editor-Link im letzten Schritt. Warte nicht, bis die Verarbeitung fertig ist.
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. Lies den Job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Ersetze {taskId} durch die taskId aus der Upload-Antwort.
Die Antwort enthält status, pageCount und die erkannten Einträge.
Jeder Eintrag hat id, page, text und redact. Ein Eintrag hat manchmal auch tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Nimm Einträge an oder lehne sie ab
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions mit den JSON-Arrays accept und reject aus Eintrags-Ids.
Sende beide Arrays. Mindestens eine Id ist erforderlich, in einem der beiden Arrays. Das andere Array darf leer sein.
Das aktualisiert diese Einträge und erzeugt die Datei.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Lade die PDF herunter
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Wenn die Erzeugung erfolgreich ist, ist die Antwort die PDF.
Davor ist die Antwort JSON mit status. Es ist keine leere Datei. Speichere dieses JSON nicht als PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Lies das Seitenlimit
GET https://app.anonify.nl/api/v1/agent-actions/limits. Die Antwort enthält pagesLeft.
Starte keinen Checkout. Bezahle nicht.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Gib der Person den Editor
Gib der Person nach dem Upload https://app.anonify.nl/edit/{taskId}. Ersetze {taskId} durch die taskId aus der Upload-Antwort.
Um diesen Browser anzumelden, füge einen Hash mit token und user aus der signup-Antwort hinzu. user ist das base64url-JSON des user-Objekts.
Baue den Hash mit URLSearchParams. Die Parameternamen sind token und user. base64url bedeutet UTF-8-JSON, dann base64, dann + durch - ersetzen, / durch _ ersetzen und das =-Padding entfernen.
Der Editor bleibt geschlossen und zeigt den Upload-Fortschrittsbalken, während das Dokument verarbeitet wird. Danach lädt er sich selbst.
Du hast token und user nur aus signup. Bei einem bestehenden Konto gib https://app.anonify.nl/edit/{taskId} ohne Hash. Die Person meldet sich mit ihrem eigenen Login an.
Rufe die React-Routen /media und /tasks nicht auf.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Das ist nicht erlaubt
- Liste keine Dokumente in einem Workspace auf.
- Bezahle nicht, und starte keinen Checkout.
- Lade niemanden ein.
- Lösche nichts.
- Benenne das Unternehmen nicht um.
- Lege keinen Workspace an.
- Rufe die React-Routen /media und /tasks nicht auf.
- Rufe signup nicht auf, wenn die Person schon ein Konto hat, wenn signup sagt, dass die E-Mail schon existiert, oder wenn eine Anfrage 401 liefert.