Como um agente usa Anonify
Siga estes passos por esta ordem. Esta é a API de agente em https://app.anonify.nl. Uma pessoa também pode ler esta página.
1. Pergunte se já existe uma conta
Pergunte à pessoa se já tem uma conta Anonify.
Se tiver, não chame signup. Salte o passo de conta nova e use o passo de conta existente.
2. Conta nova
Se não tiver conta, POST https://app.anonify.nl/api/v1/auth/signup com o JSON abaixo. Omita password. Não acrescente um campo password.
username só tem letras e números. O servidor guarda-o em minúsculas. Não pode ser alterado.
A resposta inclui token, user e userKey. userKey é a chave de API. Começa por ank_.
A conta recebe uma empresa chamada My company e um workspace chamado My workspace.
A primeira vez que a pessoa abre a aplicação, esta pede para definir uma palavra-passe.
Se signup disser que o e-mail já existe, pare. A mensagem do servidor é "Username or Email already exists!". Não se registe outra vez. Peça uma chave e use o passo de conta existente.
POST https://app.anonify.nl/api/v1/auth/signup Content-Type: application/json { "username": "lettersandnumbers", "email": "person@example.com", "isManager": true, "firstName": "", "lastName": "" }3. Conta existente
Não chame signup.
A pessoa inicia sessão em https://app.anonify.nl/login e cria uma chave em https://app.anonify.nl/profile, e depois cola essa chave para si.
A chave começa por ank_. Há uma chave ativa. Uma chave nova substitui a antiga.
Um 401 significa que a chave está errada ou foi revogada. Peça uma chave nova. Não se registe outra vez.
4. Envie a chave
Envie a chave em cada pedido abaixo como Authorization: Bearer ank_...
Use userKey do signup, ou a chave que a pessoa colou. Não envie o token do signup neste cabeçalho.
Authorization: Bearer ank_...5. Leia os workspaces
GET https://app.anonify.nl/api/v1/agent-actions/workspaces. A resposta são os workspaces a que esta chave pode aceder.
Um workspace é o predefinido. Se a resposta tiver um workspace, omita workspaceId no envio.
Se a resposta tiver mais do que um workspace, o envio tem de incluir esse id de workspace como workspaceId. Pergunte à pessoa qual id usar.
Não pode criar um workspace.
GET https://app.anonify.nl/api/v1/agent-actions/workspaces Authorization: Bearer ank_...6. Envie o ficheiro
POST https://app.anonify.nl/api/v1/agent-actions/uploads como multipart form data.
Envie o campo file. PDF, PNG e JPEG são aceites.
Envie workspaceId só quando esta chave pode aceder a mais do que um workspace.
A resposta é taskId e status.
Depois desta resposta, dê à pessoa a ligação do editor no último passo. Não espere que o processamento termine.
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. Leia o job
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job. Substitua {taskId} pelo taskId da resposta de envio.
A resposta inclui status, pageCount e os itens detetados.
Cada item tem id, page, text e redact. Um item por vezes também tem tag.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/job Authorization: Bearer ank_...8. Aceite ou rejeite itens
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions com os arrays JSON accept e reject de ids de itens.
Envie os dois arrays. É obrigatório pelo menos um id, em qualquer um dos arrays. O outro array pode estar vazio.
Isto atualiza esses itens e gera o ficheiro.
POST https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/redactions Authorization: Bearer ank_... Content-Type: application/json { "accept": ["<item id>"], "reject": [] }9. Descarregue o PDF
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file.
Quando a geração termina com sucesso, a resposta é o PDF.
Antes disso, a resposta é JSON com status. Não é um ficheiro vazio. Não guarde esse JSON como PDF.
GET https://app.anonify.nl/api/v1/agent-actions/tasks/{taskId}/file Authorization: Bearer ank_...10. Leia o limite de páginas
GET https://app.anonify.nl/api/v1/agent-actions/limits. A resposta inclui pagesLeft.
Não inicie um checkout. Não pague.
GET https://app.anonify.nl/api/v1/agent-actions/limits Authorization: Bearer ank_...11. Dê o editor à pessoa
Depois do envio, dê à pessoa https://app.anonify.nl/edit/{taskId}. Substitua {taskId} pelo taskId da resposta de envio.
Para iniciar sessão nesse browser, acrescente um hash com token e user da resposta de signup. user é o JSON base64url do objeto user.
Construa o hash com URLSearchParams. Os nomes dos parâmetros são token e user. base64url significa JSON UTF-8, depois base64, depois substitua + por -, / por _, e retire o padding =.
O editor fica fechado e mostra a barra de progresso do envio enquanto o documento é processado. Depois carrega-se sozinho.
Só tem token e user a partir do signup. Para uma conta existente, dê https://app.anonify.nl/edit/{taskId} sem hash. A pessoa inicia sessão com o próprio login.
Não chame as rotas React /media ou /tasks.
https://app.anonify.nl/edit/{taskId}#token=<signup token>&user=<base64url JSON of user>
Não faça isto
- Não liste documentos de um workspace.
- Não pague e não inicie um checkout.
- Não convide ninguém.
- Não apague nada.
- Não mude o nome da empresa.
- Não crie um workspace.
- Não chame as rotas React /media ou /tasks.
- Não chame signup se a pessoa já tiver uma conta, se signup disser que o e-mail já existe, ou se um pedido devolver 401.