Sådan bruger en agent Anonify

Følg disse trin i denne rækkefølge. Dette er agent-API’en på https://app.anonify.nl. En person kan også læse siden.

1. 1. Spørg om der allerede er en konto

   Spørg personen, om vedkommende allerede har en Anonify-konto.

   Hvis ja, kald ikke signup. Spring trinnet for en ny konto over, og brug trinnet for en eksisterende konto.

2. 2. Ny konto

   Hvis vedkommende ikke har en konto, POST https://app.anonify.nl/api/v1/auth/signup med JSON nedenfor. Udelad password. Tilføj ikke et password-felt.

   username er kun bogstaver og tal. Serveren gemmer det med små bogstaver. Det kan ikke ændres.

   Svaret indeholder token, user og userKey. userKey er API-nøglen. Den starter med ank_.

   Kontoen får en virksomhed ved navn My company og et workspace ved navn My workspace.

   Første gang personen åbner appen, beder den om at sætte en adgangskode.

   Hvis signup siger, at e-mailen allerede findes, så stop. Serverbeskeden er "Username or Email already exists!". Tilmeld ikke igen. Bed om en nøgle, og brug trinnet for en eksisterende 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. 3. Eksisterende konto

   Kald ikke signup.

   Personen logger ind på https://app.anonify.nl/login og opretter én nøgle på https://app.anonify.nl/profile, og indsætter derefter den nøgle hos dig.

   Nøglen starter med ank_. Én nøgle er aktiv. En ny nøgle erstatter den gamle.

   401 betyder, at nøglen er forkert eller tilbagekaldt. Bed om en ny nøgle. Tilmeld ikke igen.

4. 4. Send nøglen

   Send nøglen på hvert kald nedenfor som Authorization: Bearer ank_...

   Brug userKey fra signup, eller den nøgle personen indsatte. Send ikke signup-token i dette header.

   Authorization: Bearer ank_...

5. 5. Læs workspaces

   GET https://app.anonify.nl/api/v1/agent-actions/workspaces. Svaret er de workspaces, denne nøgle kan tilgå.

   Ét workspace er standard. Når svaret indeholder ét workspace, så udelad workspaceId ved upload.

   Når svaret indeholder mere end ét workspace, skal upload inkludere det workspace-id som workspaceId. Spørg personen, hvilket id du skal bruge.

   Du kan ikke oprette et workspace.

   GET https://app.anonify.nl/api/v1/agent-actions/workspaces
   Authorization: Bearer ank_...

6. 6. Upload filen

   POST https://app.anonify.nl/api/v1/agent-actions/uploads som multipart form data.

   Send feltet file. PDF, PNG og JPEG accepteres.

   Send workspaceId kun når denne nøgle kan tilgå mere end ét workspace.

   Svaret er taskId og status.

   Giv personen editorlinket i det sidste trin efter dette svar. Vent ikke på, at behandlingen er færdig.

   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. 7. Læs jobbet

   GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Erstat {taskId} med taskId fra upload-svaret.

   Svaret indeholder status, pageCount og de fundne elementer.

   Hvert element har id, page, text og redact. Et element har nogle gange også tag.

   GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job
   Authorization: Bearer ank_...

8. 8. Acceptér eller afvis elementer

   POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions med JSON-arrays accept og reject med element-id’er.

   Send begge arrays. Mindst ét id er påkrævet, i et af de to arrays. Det andet array må være tomt.

   Det opdaterer de elementer og genererer filen.

   POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions
   Authorization: Bearer ank_...
   Content-Type: application/json
   
   {
     "accept": ["<item id>"],
     "reject": []
   }

9. 9. Hent PDF-filen

   GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.

   Når genereringen lykkes, er svaret PDF-filen.

   Inden da er svaret JSON med status. Det er ikke en tom fil. Gem ikke den JSON som en PDF.

   GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file
   Authorization: Bearer ank_...

10. 10. Læs sidegrænsen

    GET https://app.anonify.nl/api/v1/agent-actions/limits. Svaret indeholder pagesLeft.

    Start ikke et checkout. Betal ikke.

    GET https://app.anonify.nl/api/v1/agent-actions/limits
    Authorization: Bearer ank_...

11. 11. Giv personen editoren

    Efter upload, giv personen https://app.anonify.nl/edit/{taskId}. Erstat {taskId} med taskId fra upload-svaret.

    For at logge den browser ind, tilføj en hash med token og user fra signup-svaret. user er base64url-JSON for user-objektet.

    Byg hashen med URLSearchParams. Parameternavnene er token og user. base64url betyder UTF-8-JSON, derefter base64, derefter erstat + med -, / med _, og fjern =-padding.

    Editoren forbliver lukket og viser uploadens statuslinje, mens dokumentet behandles. Derefter indlæser den sig selv.

    Du har kun token og user fra signup. For en eksisterende konto, giv https://app.anonify.nl/edit/{taskId} uden hash. Personen logger ind med sit eget login.

    Kald ikke React-ruterne /media eller /tasks.

    https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>