Hoe een agent Anonify gebruikt
Volg deze stappen in deze volgorde. Dit is de agent-API op https://app.anonify.nl. Een persoon kan deze pagina ook lezen.
1. Vraag of er al een account is
Vraag de persoon of die al een Anonify-account heeft.
Zo ja, roep signup niet aan. Sla de stap voor een nieuw account over en gebruik de stap voor een bestaand account.
2. Nieuw account
Als die geen account heeft, POST https://app.anonify.nl/api/v1/auth/signup met de JSON hieronder. Laat password weg. Voeg geen password-veld toe.
username bevat alleen letters en cijfers. De server slaat het in kleine letters op. Het kan niet worden gewijzigd.
Het antwoord bevat token, user en userKey. userKey is de API-sleutel. Die begint met ank_.
Het account krijgt een bedrijf met de naam My company en een workspace met de naam My workspace.
De eerste keer dat de persoon de app opent, vraagt die om een wachtwoord in te stellen.
Als signup zegt dat het e-mailadres al bestaat, stop. Het serverbericht is "Username or Email already exists!". Meld je niet opnieuw aan. Vraag om een sleutel en gebruik de stap voor een bestaand account.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Bestaand account
Roep signup niet aan.
De persoon logt in op https://app.anonify.nl/login en maakt één sleutel aan op https://app.anonify.nl/profile, en plakt die sleutel daarna bij jou.
De sleutel begint met ank_. Er is één actieve sleutel. Een nieuwe sleutel vervangt de oude.
Een 401 betekent dat de sleutel fout of ingetrokken is. Vraag om een nieuwe sleutel. Meld je niet opnieuw aan.
4. Stuur de sleutel
Stuur de sleutel bij elk request hieronder als Authorization: Bearer ank_...
Gebruik userKey uit signup, of de sleutel die de persoon heeft geplakt. Stuur het signup-token niet in deze header.
Authorization: Bearer ank_...5. Lees de workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. Het antwoord is de workspaces die deze sleutel kan openen.
Eén workspace is de standaard. Als het antwoord één workspace bevat, laat workspaceId weg bij de upload.
Als het antwoord meer dan één workspace bevat, moet de upload dat workspace-id meesturen als workspaceId. Vraag de persoon welk id je moet gebruiken.
Je kunt geen workspace aanmaken.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Upload het bestand
POST https://app.anonify.nl/api/v1/agent-actions/uploads als multipart form data.
Stuur het veld file. PDF, PNG en JPEG worden geaccepteerd.
Stuur workspaceId alleen als deze sleutel meer dan één workspace kan openen.
Het antwoord is taskId en status.
Geef de persoon na dit antwoord de editorlink in de laatste stap. Wacht niet tot de verwerking klaar is.
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. Lees de job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Vervang {taskId} door de taskId uit het upload-antwoord.
Het antwoord bevat status, pageCount en de gevonden items.
Elk item heeft id, page, text en redact. Een item heeft soms ook tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Accepteer of wijs items af
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions met JSON-arrays accept en reject van item-ids.
Stuur beide arrays. Minstens één id is verplicht, in een van de twee arrays. De andere array mag leeg zijn.
Dit werkt die items bij en genereert het bestand.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Download de PDF
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Als het genereren gelukt is, is het antwoord de PDF.
Daarvoor is het antwoord JSON met status. Het is geen leeg bestand. Sla die JSON niet op als PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Lees de paginalimiet
GET https://app.anonify.nl/api/v1/agent-actions/limits. Het antwoord bevat pagesLeft.
Start geen checkout. Betaal niet.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Geef de persoon de editor
Geef de persoon na de upload https://app.anonify.nl/edit/{taskId}. Vervang {taskId} door de taskId uit het upload-antwoord.
Om die browser in te loggen, voeg een hash toe met token en user uit het signup-antwoord. user is de base64url-JSON van het user-object.
Bouw de hash met URLSearchParams. De parameternamen zijn token en user. base64url betekent UTF-8 JSON, dan base64, daarna + vervangen door -, / vervangen door _, en = padding verwijderen.
De editor blijft dicht en toont de voortgangsbalk van de upload terwijl het document wordt verwerkt. Daarna laadt de editor zichzelf.
Je hebt token en user alleen uit signup. Bij een bestaand account geef je https://app.anonify.nl/edit/{taskId} zonder hash. De persoon logt in met de eigen login.
Roep de React-routes /media en /tasks niet aan.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Doe dit niet
- Toon geen documenten in een workspace.
- Betaal niet, en start geen checkout.
- Nodig niemand uit.
- Verwijder niets.
- Hernoem het bedrijf niet.
- Maak geen workspace.
- Roep de React-routes /media en /tasks niet aan.
- Roep signup niet aan als de persoon al een account heeft, als signup zegt dat het e-mailadres al bestaat, of als een request 401 teruggeeft.