Todas as atualizações da api serão reportadas nesse portal. Novas rotas, novas versões de apis, apis depreciadas etc.
IMPORTATE - APIS DEPRECIADAS
Após a depreciação de uma api é recomendado que as integrações atualizem suas implementações para obter mais desempenho e segurança.
Sendo assim, sempre que se deparar com a expressão deprecated, dentro desta documentação ou swagger, saiba que esta determinada rota será descontinuado em breve.
Rotas depreciadas permanecerão funcionais por no mínimo 12 meses. Após esse período poderão ser inativadas.
| Descrição | Api | Rota | Data |
|---|---|---|---|
| Exclusão de apis depreciadas do read.me | Todas depreciadas | Todas depreciadas | 19/08/24 |
| Inclusão de novas rotas. Registrar leitura inicial e final de documento Buscar parametros da empresa dona do documento | Documents | POST /v1/publicacoes/{id}/leituras GET /v1/publicacoes/{id}/tenant/params | 23/11/23 |
| Inclusão de novas rotas. Rota para criar assinatura manuscrita ou rubrica Rota para obter uma assinatura manuscrita ou rubrica | SignIntegration | PUT /v1/Subscricao GET /v1/Subscricao/{tipo} | 23/11/23 |
| Inclusão de novas rotas. Rota para alterar senha do usuário logado. Rota para alterar perfil do usuário logado. | IdentityIntegration | POST /api/users/change-password PUT api/users | 10/11/23 |
| Inclusão de API Rota para listar eventos do TAE que podem ter webhook Rota responsável por criar uma Subscription (WebHook). Rota responsável por listar todas as Subscriptions (WebHook). vinculadas a empresa do usuário administrador logado. Rota utilizado para consultar uma Subscription (WebHook) pelo id. Rota usado para editar uma Subscription (WebHook). Adiciona o Callback personalizado vinculado a uma Subscription (WebHook).. | Webhooks | GET /v1/webhookevent POST /v1/subscription GET /v1/subscription GET /v1/subscription/{subscriptionId} PATCH /v1/subscription POST /v1/callbacks | 29/08/23 |
| Inclusão de API Rota para incluir um callback em uma publicação | Signintegration | /POST /v1/Publicacoes/{IdArquivo}/CallBacks | 29/08/23 |
| Inclusão de parâmetros opcionais (Opção da publicação: intervaloLembrete) | SignIntegration | POST /v2/Publicacoes | 21/08/23 |
| Inclusão de parâmetros opcionais (Opção da publicação: intervaloLembrete) | SignIntegration | PUT /v2/PublicacaoOpcoes | 21/08/23 |
| Inclusão de API Rota utilizada para listar todos os papeis de assinantes disponíveis no TAE. | SignIntegration | GET /v1/papeis-assinante | 21/08/23 |
| Inclusão API Rota para consultar destinatários de uma publicação Rota para substituir arquivo enquanto for um rascunho Rota utilizada para baixar um documento através de uma url assinada (jornada de assinatura sem cadastro) | Documents | POST documents/v1/publicacoes/{id}/destinatarios PUT documents/v1/publicacoes/{id}/files GET documents/v1/publicacoes/download/signed-url | 29/05/23 |
| Depreciação rota (Implementação de nova rota para upload de arquivos que aceita .doc e .docx) | Storage/ Documents | POST (antiga) storage/api/Storage/list POST (nova) documents/v1/envelopes/upload | 23/05/23 |
| Inclusão API Rota para upload de arquivos que aceita .doc e .docx | Documents | POST documents/v1/envelopes/upload | 11/05/23 |
| Inclusão de parâmetros opcionais (Opção da publicação: permiteRejeitarDocumento) | SignIntegration | POST /v2/Publicacoes | 06/04/23 |
| Inclusão de parâmetros opcionais (Opção da publicação: permiteRejeitarDocumento) | SignIntegration | PUT /v2/PublicacaoOpcoes | 06/04/23 |
| Inclusão API (Épico Assinatura Simplificada - Rota para rejeitar sem cadastro) | SignIntegration | POST /v2/Assinaturas/rejeitar-sem-cadastro | 06/04/23 |
| Inclusão API Rota para renovação de TOKEN JWE pelo refreshtoken | IdentityIntegration | POST /v1/auth/refreshToken | 06/04/23 |
| Depreciação Rotas (Implementação de nova rota com token JWE e refresh token) | IdentityIntegration | POST /api/auth/login Substituida pela /v2/auth/login | 06/04/23 |
| Inclusão API (Épico Assinatura Simplificada - Solicitar código para autenticação) | IdentityIntegration | POST /v1/verification-codes/send | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Validar código para autenticação) | IdentityIntegration | POST /v1/verification-codes/validate | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Obter totais de publicacoes que enviei para um destinatário) | Documents | POST /v1/publicacoes/dashboard/destinatario | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Listar publicacções que enviei para um destinatário) | SignIntegration | POST /v1/publicacoes/destinatario | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Obter informações de uma publicação autenticado via código) | Documents | GET /v1/publicacoes/sem-cadastro/{id} | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Realizar download autenticado via código) | Documents | GET /v1/publicacoes/sem-cadastro/{id}/download | 25/11/22 |
| Inclusão API (Épico Assinatura Simplificada - Assinar sem cadastro) | SignIntegration | POST /v2/Assinaturas/sem-cadastro | 25/11/22 |
| Inclusão de campos opcionais (Épico Assinatura Simplificada - Publicar com destinatários sem necessidade de efetuarem login) | SignIntegration | POST /v2/Publicacoes | 25/11/22 |
| Inclusão de campos opcionais (Épico Assinatura Simplificada - Adicionar destinatários sem necessidade de efetuarem login) | SignIntegration | POST /v2/Publicacoes/destinatario-list | 25/11/22 |
| Inclusão API | Documents | POST /v1/publicacoes/pesquisas GET /v1/publicacoes/{id} GET /v1/publicacoes/{id}/download | 27/04/22 |
| Depreciação Rotas | Storage | POST /v1/Storage GET /v1/Storage | 27/04/22 |
| Depreciação Rotas | SignIntegration | GET /v2/publicacoes/{id} GET /v2/publicacoes/filter GET /v2/publicacoes/filter-basic | 27/04/22 |
| Inclusão API | Contact | GET /v1/contatos DELETE /v1/contatos PUT /v1/contatos POST /v1/contatos GET /v1/contatos/usuario | 27/04/22 |
| Inclusão Rotas | Contact | GET /v1/grupos POST /v1/grupos PUT /v1/grupos DELETE /v1/grupos GET /v1/grupos/usuario POST /v1/contatos-grupo DELETE /v1/contatos-grupo | 27/04/22 |
| Inclusão Rotas | Documents | GET /v1/pastas POST /v1/pastas GET /v1/pastas/{id} DELETE /v1/pastas/{id} POST /v1/pastas/{id}/arquivos DELETE /v1/pastas/{id}/arquivos | 27/04/22 |
| Inclusão Rotas | Documents | GET /v1/pastas/compartilhadas GET /v1/pastas/compartilhadas/{id} POST /v1/pastas/{id}/contatos GET /v1/pastas/{id}/contatos DELET /v1/pastas/{id}/contatos | 27/04/22 |
| Inativação Rotas | SignIntegration | Todas as rotas V1 | 04/04/22 |
| Depreciação Rotas | SignIntegration | Todas as rotas V1 | 04/04/21 |