Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

composition-setup
Informações
titleDepreciação e desativação de apis

Após a depreciação de uma api 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 swaggerSwagger), saiba que esta determinada 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.

deck.tab.active.background = #FFFFFF
deck.tab.inactive.background = #FFFFFF

deck.card.border = 4px black
deck.card.background = #F6F9F9
Informações
titleAtenção - Obsolescência Programada

É importante sempre se atentar aos avisos de depreciação de apis e utilizar sempre as versões mais recentes.
A lista abaixo contém as apis rotas/ APIs que serão desativadas a partir de 3001/11/25 em diante. É 26 em diante; é importante que todos os produtos se programem para evitar impactos nos clientes.!

Informações
titleAtenção - Obsolescência Programada
DescriçãoAPIROTADepreciado emDescontinua emMotivo

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/2330/11/25

Depreciação rota

Login

IdentityIntegration

POST (Depreciada)
/api/auth/login


POST (nova rota)

/v2/auth/login

06/04/2330/11/25

Depreciação rota

Upload de arquivo

Storage

POST (Depreciada)
storage/api/Storage


POST (nova rota)
documents/v1/envelopes/upload


27/04/2230/11/25

Depreciação rota

Download arquivo

Storage

GET (Depreciada)
/v1/Storage


GET (nova rota) /v1/publicacoes/{id}/download


27/04/2230/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/2230/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/2230/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/2430/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/2430/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/2430/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/2330/11/25




...