Så använder en agent Anonify
Följ dessa steg i den här ordningen. Det här är agent-API:t på https://app.anonify.nl. En person kan också läsa sidan.
1. Fråga om ett konto redan finns
Fråga personen om hen redan har ett Anonify-konto.
Om ja, anropa inte signup. Hoppa över steget för nytt konto och använd steget för befintligt konto.
2. Nytt konto
Om hen inte har ett konto, POST https://app.anonify.nl/api/v1/auth/signup med JSON nedan. Utelämna password. Lägg inte till ett password-fält.
username är bara bokstäver och siffror. Servern sparar det med små bokstäver. Det kan inte ändras.
Svaret innehåller token, user och userKey. userKey är API-nyckeln. Den börjar med ank_.
Kontot får ett företag som heter My company och en workspace som heter My workspace.
Första gången personen öppnar appen ber den om ett lösenord.
Om signup säger att e-postadressen redan finns, stanna. Servermeddelandet är "Username or Email already exists!". Registrera inte igen. Be om en nyckel och använd steget för befintligt 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. Befintligt konto
Anropa inte signup.
Personen loggar in på https://app.anonify.nl/login och skapar en nyckel på https://app.anonify.nl/profile, och klistrar sedan in den nyckeln hos dig.
Nyckeln börjar med ank_. En nyckel är aktiv. En ny nyckel ersätter den gamla.
401 betyder att nyckeln är fel eller återkallad. Be om en ny nyckel. Registrera inte igen.
4. Skicka nyckeln
Skicka nyckeln på varje anrop nedan som Authorization: Bearer ank_...
Använd userKey från signup, eller nyckeln personen klistrade in. Skicka inte signup-token i den här headern.
Authorization: Bearer ank_...5. Läs workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. Svaret är de workspaces som den här nyckeln kan nå.
En workspace är standard. När svaret innehåller en workspace, utelämna workspaceId vid uppladdningen.
När svaret innehåller mer än en workspace måste uppladdningen ta med det workspace-id:t som workspaceId. Fråga personen vilket id du ska använda.
Du kan inte skapa en workspace.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Ladda upp filen
POST https://app.anonify.nl/api/v1/agent-actions/uploads som multipart form data.
Skicka fältet file. PDF, PNG och JPEG accepteras.
Skicka workspaceId bara när den här nyckeln kan nå mer än en workspace.
Svaret är taskId och status.
Efter det här svaret, ge personen editorlänken i sista steget. Vänta inte på att bearbetningen blir klar.
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. Läs jobbet
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Ersätt {taskId} med taskId från uppladdningssvaret.
Svaret innehåller status, pageCount och de hittade posterna.
Varje post har id, page, text och redact. En post har ibland också tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Godkänn eller avvisa poster
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions med JSON-arrayerna accept och reject med post-id:n.
Skicka båda arrayerna. Minst ett id krävs, i någon av arrayerna. Den andra arrayen får vara tom.
Det uppdaterar de posterna och skapar 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. Hämta PDF:en
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
När skapandet har lyckats är svaret PDF:en.
Före det är svaret JSON med status. Det är inte en tom fil. Spara inte den JSON:en som en PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Läs sidgränsen
GET https://app.anonify.nl/api/v1/agent-actions/limits. Svaret innehåller pagesLeft.
Starta inte en checkout. Betala inte.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Ge personen editorn
Efter uppladdningen, ge personen https://app.anonify.nl/edit/{taskId}. Ersätt {taskId} med taskId från uppladdningssvaret.
För att logga in den webbläsaren, lägg till en hash med token och user från signup-svaret. user är base64url-JSON för user-objektet.
Bygg hashen med URLSearchParams. Parameternamnen är token och user. base64url betyder UTF-8-JSON, sedan base64, sedan ersätt + med -, / med _, och ta bort =-utfyllnad.
Editorn förblir stängd och visar uppladdningens förloppsindikator medan dokumentet bearbetas. Sedan laddar den sig själv.
Du har token och user bara från signup. För ett befintligt konto, ge https://app.anonify.nl/edit/{taskId} utan hash. Personen loggar in med sin egen inloggning.
Anropa inte React-rutterna /media eller /tasks.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Gör inte det här
- Lista inte dokument i en workspace.
- Betala inte, och starta inte en checkout.
- Bjud inte in någon.
- Radera inget.
- Byt inte namn på företaget.
- Skapa ingen workspace.
- Anropa inte React-rutterna /media eller /tasks.
- Anropa inte signup om personen redan har ett konto, om signup säger att e-postadressen redan finns, eller om ett anrop svarar 401.