Histórico da Página

...

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!

Table Filter

false->

fixedCols
totalrow	,,,,,,
hidelabels	false
inverse	false
datefilter	Depreciada em
ddSeparator
sparkName	Sparkline
hidePane	Table header
customNoTableMsgText
limitHeight
sparkline	false
default	->
isFirstTimeEnter	true
cell-width
hideColumns	false
totalRowName
totalColName
customNoTableMsg	false
disabled	false
enabledInEditor	false
globalFilter	false
id	1758834541568_-1483030726
iconfilter
order	0
hideControls	false
inverse	false
numbering
datefilter	Depreciada em
column
sort	Depreciada em ⇩
totalcol
disableSave	false
rowsPerPage	isNew
separator	Point (.)
labels	Depreciada em
defaultthousandSeparator
ignoreFirstNrows
ddOperator
cell-widthuserfilter
datepattern	yy-mm-dd
numberfilter
heightValue
hideFilters
updateSelectOptions	false	id
worklog	365\|5\|8\|y w d h m\|y w d h m1758827265172
isOR	AND
formatVersion	2
order	0
showNRowsifNotFiltered

StorageapiStorage/listenvelopes/upload2505202327/04/2022, além da mudança de serviço27/04/202227/04/2022GET/filterPOSTv4pesquisas27042022 não retorna documentos em status CanceladoPOSTpublicacoes/pesquisasPOSTv4publicacoespesquisas27042022Importante: a rota depreciada não retorna documentos em status Cancelado.POSTadministratorsuserPOSTadministrators/user10112024

GET

publicacoes/sem-cadastro/{id}

GET

/v2/publicacoes/sem-cadastro02042024 Importante: a rota depreciada não retorna documentos em status Cancelado.02/04/2024Adição de regra para validar assinaturas manuscritas contatocontatoscontatos Contactv1contatos-grupogrupos/{id}/contatos29Remover contatos grupoContactDELETEv1/contatos-grupoDELETEv1grupos/{id}/contatos29/05/2023Remover contato grupoContactDELETEv1contatos-grupoDELETEgrupos/{id}/contato29/05/2023Contactgruposv2grupos29052023Contactv1gruposusuariogrupos29/05/202329/05/2023

Descrição	API/ Serviço	Rota depreciada	Rota atual	Depreciada em	Descontinua em	Observações
Autenticação de usuário	IdentityIntegration	POST /v2/auth/login	POST /v3/auth/login	21/08/2025	01/11/2026	Breaking Change: Rota depreciada devido a nova regra incluída que considera o parâmetro de obrigatoriedade de autenticação por SSO para autenticação. Caso o parâmetro esteja ativo, não será possível usuários comuns se autenticarem via rota. A configuração de permissões dos Usuários de Serviço pode ajudar a contornar essa quebra de fluxo, já que eles passam a poder Publicar Documentos.
Obter dados do usuário	IdentityIntegration	GET /v1/administrators/user	GET /v2/administrators/user	19/05/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar anexos da publicação	SignIntegration	GET /v2/Anexos/{idArquivo}	GET (Documents) /v1/publicacoes/{idDocumento}/anexos	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Incluir anexos na publicação	SignIntegration	POST /v2/Anexos/{idArquivo}	POST (Documents) /v1/publicacoes/{idDocumento}/anexos	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Baixar anexo da publicação	SignIntegration	GET /v2/Anexos/download/{idFileStream}	GET (Documents) /v1/publicacoes/{idDocumento}/anexos/{idAnexo}	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Remover anexo da publicação	SignIntegration	DELETE /v2/Anexos/{idAnexo}	DELETE (Documents) /v1/publicacoes/{idDocumento}/anexos/{idAnexo}	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Remover todos anexos da publicação	SignIntegration	DELETE /v2/Anexos/all/{idArquivo}	DELETE (Documents) /v1/publicacoes/{idDocumento}/anexos	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Upload de documentos
Publicar documento	Signintegration
	POST /
v2/
publicacoes	POST (Documents) /v1/
publicacoes
06/
12/
2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Autenticação de usuárioCriar usuário, sendo um administrador	IdentityIntegration	POST /apiv1/authadministrators/loginuser	POST /v2/authadministrators/loginuser	0610/0411/2023 2024	01/11/2026 Importante: a rota depreciada retornava tokens em formato JWT; a partir da nova os tokens serão JWE.	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.	Upload de documentos	Storage	POST /api/Storage	POST (Documents) /v1/envelopes/upload
Editar usuário, sendo um administrador	IdentityIntegration	PUT /v1/administrators/user	PUT /v2/administrators/user	10/11/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados)
.
Download de Consultar documento	Storage	GET /v1/Storage	(Autenticação por código)	Documents	GETGET (Documents) /v1/publicacoes/sem-cadastro/{id}/download		01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.	Consultar documento	SignIntegration	GET /v2/publicacoes/{id} GET (Documents) /v2/publicacoes/sem-cadastro/{id}	2702/04/20222024	01/11/2026	Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Consultar documento	Documents	GET /v1/publicacoes/{id}	GET /v2/publicacoes/{id}
.
Realizar assinatura (Autenticação por código)	Signintegration	POST /v2/Assinaturas/sem-cadastro	POST /v3/Assinaturas/sem-cadastro	02/04/2024
	01/11/2026
Importante: a rota depreciada não retorna documentos em status Cancelado.
Adição de regra para validar assinaturas manuscritas.
Excluir documento	Signintegration	DELETE
Listar e filtrar documentos	SignIntegration
/v2/publicacoes

DELETE (Documents) /
v1/publicacoes/
{id}
12/
12/
2023	01/11/2026	Importante: a rota depreciada
foi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas exclui os documentos. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Excluir documento	Signintegration	DELETE	Listar e filtrar documentos	SignIntegration	GET /v2/publicacoes/filter-basic	POST (Documents) /v4v1/publicacoes/pesquisas{id}/cancelar	12/12/202327/04/2022	01/11/2026	Importante: a rota depreciada não retorna documentos em status Canceladofoi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas cancela os documentos. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.	Listar e filtrar documentos	Documents
Consultar contato	Contact	GET /v1/
contatos
GET /
v2/
contatos/
{id}
29/
05/
2023	01/11/2026
	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover contato	Contact	DELETE	Listar e filtrar documentos	Documents	POST /v2v1/publicacoes/pesquisascontatos	POSTDELETE /v4v2/publicacoescontatos/pesquisas{id}	2729/0405/20222023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).	Listar e filtrar documentos	Documents
Alterar contato	Contact	PUTPOST /v3v1/publicacoes/pesquisascontatos	POSTPUT /v4v2/publicacoescontatos/pesquisas{id}	2729/0405/20222023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Criar usuário, sendo um administrador	IdentityIntegration
Listar todos contatos	Contact	GET
/v1/
contatos/
usuario
GET /v2/
contatos
29/
05/
2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).	Editar usuário, sendo um administrador
Incluir contato em grupo	Contact	POST	IdentityIntegration	PUT /v1/administrators/usercontatos-grupo	POSTPUT /v2/administrators/userv1/grupos/{id}/contatos	29/05/202310/11/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Consultar documento (Autenticação por código)	Documents
Remover contatos de grupo	Contact	DELETE /v1/
contatos-grupo	DELETE /v1/grupos
/{id}/contatos
29/
05/
2023	01/11/2026
	Alterações no Payload (contrato da API) e no Response (dados retornados).
Realizar assinatura (Autenticação por código)	Signintegration	POST /v2/Assinaturas/sem-cadastro	POST /v3/Assinaturas/sem-cadastro
Remover contato de grupo	Contact	DELETE /v1/contatos-grupo	DELETE /v1/grupos/{id}/contato	29/05/2023
	01/11/2026
Alterações no Payload (contrato da API) e no Response (dados retornados).
Consultar
grupo	Contact	GET /v1/
grupos	GET /v2/
grupos/{id}	29/05/2023
	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover contatoListar todos grupos	Contact	DELETEGET /v1/grupos/contatosusuario	DELETEGET /v2/contatos/{id}grupos	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Alterar contatogrupo	Contact	PUT /v1/contatosgrupos	PUT /v2/contatosgrupos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar todos contatosRemover grupo	Contact	GETDELETE /v1/contatos/usuariogrupos	GETDELETE /v2/contatosgrupos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).	Incluir contato em grupo
Upload de documentos	Storage	POST /api/
Storage/
list	POST (Documents) /v1/
envelopes/upload	25
/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Autenticação de
usuário
IdentityIntegration
POST /
api/auth/login	POST /
v2/
auth/login	06/04/2023
	01/11/2026	Importante: a rota depreciada retornava tokens em formato JWT; a partir da nova os tokens serão JWE. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Upload de
documentos
Storage
POST /
api/
Storage	POST (Documents) /v1/
envelopes/upload	27/04/2022
	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Consultar grupo
Download de documento	Storage
	GET /v1/
Storage	GET (Documents) /
v1/
publicacoes/{id}/download
27/
04/
2022	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Listar todos grupos
Consultar documento	SignIntegration
	GET /
v2/
publicacoes/
{id}	GET (Documents) /v2/
publicacoes/{id}	27/04/2022
	01/11/2026	Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Alterar grupoConsultar documento	ContactDocuments	PUTGET /v1/publicacoes/grupos{id}	PUTGET /v2/grupospublicacoes/{id}	2927/0504/20232022	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).	Remover grupo	Contact	DELETE /v1/grupos	DELETE /v2/grupos/{id}	Importante: a rota depreciada não retorna documentos em status Cancelado.
Listar e filtrar documentos	SignIntegration	GET /v2/publicacoes/filter	POST (Documents) /v4/publicacoes/pesquisas	27/04/2022	01/11/2026	Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Listar e filtrar documentos	SignIntegration	GET	Excluir documento	Signintegration	DELETE /v2/publicacoes/filter-basic	DELETEPOST (Documents) /v1v4/publicacoes/{id}pesquisas	1227/1204/2023 2022	01/11/2026	Importante: a rota depreciada foi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas exclui os documentosnão retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.	Excluir documento	Signintegration
Listar e filtrar documentos	Documents	POSTDELETE /v2v1/publicacoes/pesquisas	POST (Documents) /v1v4/publicacoes/{id}/cancelarpesquisas	27/04/202212/12/2023	01/11/2026	Importante: a rota depreciada foi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas cancela os documentosnão retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Listar e filtrar documentos	Documents	Publicar documento	Signintegration	POST /v2/publicacoes/pesquisas	POST /v4/publicacoes/pesquisas	27/04/2022	01/11/2026	Alterações no Payload (contrato da API) e no Response (Documents) /v1/publicacoes dados retornados).
Listar e filtrar documentos	Documents	POST /v3/publicacoes/pesquisas	POST /v4/publicacoes/pesquisas	27/04/202206/12/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.

Árvore de páginas

Versões comparadas

Versão antiga 72

Nova versão 73

Chave