Histórico da Página

...

Documentação completa das apis: Introdução

Informações

title	Depreciação e desativação de apis

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 depreciada/deprecated dentro desta documentação (ou Swagger), saiba que esta rota será descontinuada em breve. Rotas depreciadas permanecerão funcionais por no mínimo 12 meses. Após esse período poderão ser inativadas.

A lista abaixo contém as rotas/ APIs que serão desativadas a partir de 01/11/26 em diante; é importante que todos os produtos se programem para evitar impactos nos clientes!

Descrição	API	ROTA	Depreciado em	Descontinua em	Motivo
Depreciação rota Autenticação de usuário integrador	IdentityIntegration	POST (Depreciada) /identityintegration/v2/auth/login POST (Rota nova) /identityintegration/v3/auth/login	21/08/25	21/08/26	(Breaking Change) Rota depreciada devido a nova regra incluída que considera o parâmetro de obrigatoriedade de autenticação por SSO para realização do login. Caso o parâmetro esteja ativo, não será possível usuários comuns se autenticarem via rota de integração. A configuração de permissões dos Usuários de Serviço pode ajudar a contornar essa quebra de fluxo.
Depreciação rota Obter dados do usuário(por id e por email)	IdentityIntegration	GET (Depreciada) /identityintegration/v1/administrators/user GET (nova rota) /identityintegration/v2/administrators/user	19/05/25	19/05/26
Depreciação rota Manipulação de anexos da publicação	SignIntegration	GET (Depreciada) /v2/Anexos/{idArquivo} POST (Depreciada) /v2/Anexos/{idArquivo} GET (Depreciada) /v2/Anexos/download/{idFileStream} DELETE (Depreciada) /v2/Anexos/{idAnexo} DELETE (Depreciada) /v2/Anexos/all/{idArquivo} GET (nova rota) documents/v1/publicacoes/{idDocumento}/anexos POST (nova rota) documents/v1/publicacoes/{idDocumento}/anexos DELETE (nova rota) documents/v1/publicacoes/{idDocumento}/anexos GET (nova rota) documents/v1/publicacoes/{idDocumento}/anexos/{idAnexo} DELETE (nova rota) documents/v1/publicacoes/{idDocumento}/anexos/{idAnexo}	10/02/25	10/02/26
Depreciação rota Enviar publicação	SignIntegration	POST (Depreciada) signintegration/v2/Publicacoes POST (nova rota) documents/v1/publicacoes	06/12/24	30/11/25
Depreciação rota Upload de arquivo	Storage	POST (Depreciada) storage/api/Storage/list POST (nova rota) documents/v1/envelopes/upload	23/05/23	30/11/25
Depreciação rota Login	IdentityIntegration	POST (Depreciada) /api/auth/login POST (nova rota) /v2/auth/login	06/04/23	30/11/25
Depreciação rota Upload de arquivo	Storage	POST (Depreciada) storage/api/Storage POST (nova rota) documents/v1/envelopes/upload	27/04/22	30/11/25
Depreciação rota Download arquivo	Storage	GET (Depreciada) /v1/Storage GET (nova rota) /v1/publicacoes/{id}/download	27/04/22	30/11/25
Depreciação rota Consulta envelope por id	SignIntegration Documents	GET (Depreciada) signintegration/v2/publicacoes/{id} GET (Depreciada) documents/v1/publicacoes/{id} GET (nova rota) /v2/publicacoes/{id}	27/04/22	30/11/25
Depreciação rota Buscar e filtrar envelopes	SignIntegration Documents	GET (Depreciada) signIntegration/v2/publicacoes/filter GET (Depreciada) signIntegration/v2/publicacoes/filter-basic POST (Depreciada) documents/v1/publicacoes/pesquisas POST (Depreciada) documents/v2/publicacoes/pesquisas POST (Depreciada) documents/v3/publicacoes/pesquisas POST (nova rota) documents/v4/publicacoes/pesquisas	27/04/22	30/11/25
Depreciação rota Criar e editar usuario através de um administrador	IdentityIntegration	POST (Depreciada) /v1/administrators/user PUT (Depreciada) /v1/administrators/user POST (nova rota) /v2/administrators/user PUT (nova rota) /v2/administrators/user	10/11/24	30/11/25
Depreciação rota Consulta envelope por id (Autenticação por código / Sem cadastro)	Documents	GET (Depreciada) /v1/publicacoes/sem-cadastro/{id} GET (nova rota) /v2/publicacoes/sem-cadastro/{id}	02/04/24	30/11/25
Depreciação rota Realizar assinatura (Autenticação por código / Sem cadastro)	Signintegration	POST (Depreciada) /v2/Assinaturas/sem-cadastro POST (nova rota) /v3/Assinaturas/sem-cadastro	02/04/24	30/11/25
Depreciação rota Manipulação de contatos e grupos de agenda	Contact	GET (Depreciada) /v1/contatos DELETE (Depreciada) /v1/contatos PUT (Depreciada) /v1/contatos GET (Depreciada) /v1/contatos/usuario POST (Depreciada) /v1/contatos-grupo DELETE (Depreciada) /v1/contatos-grupo GET (Depreciada) /v1/grupos PUT (Depreciada) /v1/grupos DELETE (Depreciada) /v1/grupos GET (Depreciada) /v1/grupos/usuario GET (nova rota) /v2/contatos/{id} DELETE (nova rota) /v2/contatos/{id} PUT (nova rota) /v2/contatos/{id} GET (nova rota) /v2/contatos GET (nova rota) /v2/grupos/{id} PUT (nova rota) /v2/grupos/{id} DELETE (nova rota) /v2/grupos/{id} GET (nova rota) /v2/grupos POST (nova rota) /v1/grupos/{id}/contatos DELETE (nova rota) /v1/grupos/{id}/contatos DELETE (nova rota) /v1/grupos/{id}/contato	29/05/23	30/11/25

Expandir

title	Histórico completo

Descrição	API	ROTA	Data
Depreciação rota (Implementação de nova rota para publicação de envelopes)	SignIntegration / Documents	POST (antiga) signintegration/v2/Publicacoes POST (nova) documents/v1/publicacoes	06/12/24
Exclusão de apis depreciadas do read.me	Todas depreciadas	Todas depreciadas	19/08/24
Depreciação rota Assinatura em rota sem cadastro	SignIntegration	POST (Depreciada) /v2/Assinaturas/sem-cadastro POST (Nova) /v2/Assinaturas/sem-cadastro	02/04/24
Depreciação rota Consultar envelope em rota sem cadastro	Documents	GET (Depreciada) /v1/publicacoes/sem-cadastro/{id} GET (nova rota) /v2/publicacoes/sem-cadastro/{id}	02/04/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
Depreciação rota Manipulação de contatos e grupos de agenda	Contact	GET (antiga) /v1/contatos DELETE (antiga) /v1/contatos PUT (antiga) /v1/contatos GET (antiga) /v1/contatos/usuario POST (antiga) /v1/contatos-grupo DELETE (antiga) /v1/contatos-grupo GET (antiga) /v1/grupos PUT (antiga) /v1/grupos DELETE (antiga) /v1/grupos GET (antiga) /v1/grupos/usuario GET (nova) /v2/contatos/{id} DELETE (nova) /v2/contatos/{id} PUT (nova) /v2/contatos/{id} GET (nova) /v2/contatos GET (nova) /v2/grupos/{id} PUT (nova) /v2/grupos/{id} DELETE (nova) /v2/grupos/{id} GET (nova) /v2/grupos POST (nova) /v1/grupos/{id}/contatos DELETE (nova) /v1/grupos/{id}/contatos DELETE (nova) /v1/grupos/{id}/contato	29/05/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/22

...

Árvore de páginas

Versões comparadas

Versão antiga 26

Nova versão 27

Chave