Näin agentti käyttää palvelua Anonify
Tee nämä vaiheet tässä järjestyksessä. Tämä on agenttirajapinta osoitteessa https://app.anonify.nl. Ihminen voi lukea tämän sivun.
1. Kysy, onko tili jo olemassa
Kysy henkilöltä, onko hänellä jo Anonify-tili.
Jos on, älä kutsu signupia. Ohita uuden tilin vaihe ja käytä olemassa olevan tilin vaihetta.
2. Uusi tili
Jos tiliä ei ole, lähetä POST https://app.anonify.nl/api/v1/auth/signup alla olevalla JSONilla. Jätä password pois. Älä lisää password-kenttää.
username sisältää vain kirjaimia ja numeroita. Palvelin tallentaa sen pienillä kirjaimilla. Sitä ei voi muuttaa.
Vastaus sisältää token, user ja userKey. userKey on API-avain. Se alkaa merkeillä ank_.
Tili saa yrityksen nimeltä My company ja työtilan nimeltä My workspace.
Kun henkilö avaa sovelluksen ensimmäisen kerran, se pyytää asettamaan salasanan.
Jos signup sanoo, että sähköposti on jo olemassa, pysähdy. Palvelimen viesti on "Username or Email already exists!". Älä rekisteröidy uudelleen. Pyydä avain ja käytä olemassa olevan tilin vaihetta.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Olemassa oleva tili
Älä kutsu signupia.
Henkilö kirjautuu osoitteessa https://app.anonify.nl/login ja luo yhden avaimen osoitteessa https://app.anonify.nl/profile, ja liittää sen jälkeen avaimen sinulle.
Avain alkaa merkeillä ank_. Yksi avain on aktiivinen. Uusi avain korvaa vanhan.
401 tarkoittaa, että avain on väärä tai peruttu. Pyydä uusi avain. Älä rekisteröidy uudelleen.
4. Lähetä avain
Lähetä avain jokaisessa alla olevassa pyynnössä otsikkona Authorization: Bearer ank_...
Käytä signup-vastauksen userKey-arvoa tai henkilön liittämää avainta. Älä lähetä signup-tokenia tässä otsikossa.
Authorization: Bearer ank_...5. Lue työtilat
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. Vastaus on työtilat, joihin tällä avaimella pääsee.
Yksi työtila on oletus. Kun vastauksessa on yksi työtila, jätä workspaceId pois lähetyksestä.
Kun vastauksessa on enemmän kuin yksi työtila, lähetyksen on sisällettävä sen työtilan id kenttänä workspaceId. Kysy henkilöltä, mitä id:tä käytät.
Et voi luoda työtilaa.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Lähetä tiedosto
POST https://app.anonify.nl/api/v1/agent-actions/uploads multipart form data -muodossa.
Lähetä kenttä file. PDF, PNG ja JPEG kelpaavat.
Lähetä workspaceId vain, kun tämä avain pääsee useampaan kuin yhteen työtilaan.
Vastaus on taskId ja status.
Tämän vastauksen jälkeen anna henkilölle editorin linkki viimeisessä vaiheessa. Älä odota käsittelyn loppumista.
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. Lue job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Korvaa {taskId} lähetyksen vastauksen taskId-arvolla.
Vastaus sisältää status, pageCount ja havaitut kohteet.
Jokaisella kohteella on id, page, text ja redact. Kohteella on joskus myös tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Hyväksy tai hylkää kohteet
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions JSON-taulukoilla accept ja reject, joissa on kohteiden id:t.
Lähetä molemmat taulukot. Vähintään yksi id vaaditaan, jommassakummassa taulukossa. Toinen taulukko saa olla tyhjä.
Tämä päivittää nämä kohteet ja tuottaa tiedoston.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Lataa PDF
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Kun tuottaminen onnistuu, vastaus on PDF.
Sitä ennen vastaus on JSON, jossa on status. Se ei ole tyhjä tiedosto. Älä tallenna sitä JSONia PDF:ksi.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Lue sivuraja
GET https://app.anonify.nl/api/v1/agent-actions/limits. Vastaus sisältää pagesLeft.
Älä aloita checkoutia. Älä maksa.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Anna henkilölle editori
Lähetyksen jälkeen anna henkilölle https://app.anonify.nl/edit/{taskId}. Korvaa {taskId} lähetyksen vastauksen taskId-arvolla.
Kirjauttaaksesi kyseisen selaimen lisää hash, jossa on token ja user signup-vastauksesta. user on user-objektin base64url-JSON.
Rakenna hash URLSearchParams-oliolla. Parametrien nimet ovat token ja user. base64url tarkoittaa UTF-8-JSONia, sitten base64, sitten korvaa + merkillä -, / merkillä _, ja poista =-täyte.
Editori pysyy kiinni ja näyttää lähetyksen edistymispalkin, kun dokumenttia käsitellään. Sitten se latautuu itsestään.
Saat token- ja user-arvot vain signupista. Olemassa olevalle tilille anna https://app.anonify.nl/edit/{taskId} ilman hashia. Henkilö kirjautuu omalla kirjautumisellaan.
Älä kutsu React-reittejä /media tai /tasks.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Älä tee näitä
- Älä listaa työtilan dokumentteja.
- Älä maksa, äläkä aloita checkoutia.
- Älä kutsu ketään.
- Älä poista mitään.
- Älä nimeä yritystä uudelleen.
- Älä luo työtilaa.
- Älä kutsu React-reittejä /media tai /tasks.
- Älä kutsu signupia, jos henkilöllä on jo tili, jos signup sanoo sähköpostin olevan jo olemassa, tai jos pyyntö palauttaa 401.