Histórico da Página
...
| Informações | ||
|---|---|---|
| ||
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! |
| Informações | |||||
|---|---|---|---|---|---|
| |||||
Ainda no tema, vamos descontinuar uma tela de autenticação externa, utilizada por alguns produtos integradores. As integrações que desejam continuar realizando autenticações no TAE precisam desenvolver uma interface visual própria para isso, além de consumir nossas APIs que tratam desse contexto. A tela em questão foi depreciada em 06/04/2023, será descontinuada em 01/03/2027 e era acessada por um dos links abaixo:
|
| Descrição | API/ Serviço | Rota depreciada | Rota atual | Depreciada em | Descontinua em | Observações |
|---|---|---|---|---|---|---|
Contagem de documentos por status | SignIntegration | GET /v2/publicacoes/dashboard | N/A |
|
| Rota depreciada pois deve ser usada apenas internamente pelo produto. |
Autenticação de usuário |
| IdentityIntegration | POST /v2/auth/login | POST |
|
|
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 |
|
Alterações no Payload (contrato da API) e no Response (dados retornados). | |
| Listar |
| anexos da publicação | SignIntegration | GET /v2/Anexos/{idArquivo} | GET (Documents) |
|
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) |
|
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) |
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) |
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) |
Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço. | |
Publicar documento | Signintegration |
POST /v2/ |
publicacoes | POST (Documents) |
|
POST
/api/Storage/list
POST
/documents/v1/envelopes/upload
Login
POST
/api/auth/login
POST
/identityintegration/v2/auth/login
Upload de arquivo
POST
/api/Storage
POST
/documents/v1/envelopes/upload
Download arquivo
GET
/v1/Storage
GET
/documents/v1/publicacoes/{id}/download
Consulta envelope por id
SignIntegration
GET
/v2/publicacoes/{id}
GET
/documents/v2/publicacoes/{id}
Consulta envelope por id
Documents
GET
/v1/publicacoes/{id}
GET
/documents/v2/publicacoes/{id}
Buscar e filtrar envelopes
SignIntegration
GET
/v2/publicacoes/filter
POST
/documents/v4/publicacoes/pesquisas
Buscar e filtrar envelopes
SignIntegration
GET
/v2/publicacoes/filter-basic
POST
/documents/v4/publicacoes/pesquisas
Buscar e filtrar envelopes
Documents
POST
/v1/publicacoes/pesquisas
POST
/documents/v4/publicacoes/pesquisas
Buscar e filtrar envelopes
Documents
POST
/v2/publicacoes/pesquisas
POST
/documents/v4/publicacoes/pesquisas
Buscar e filtrar envelopes
Documents
POST
/v3/publicacoes/pesquisas
POST
/documents/v4/publicacoes/pesquisas
Criar e editar usuario através de um administrador
| Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço. | |||||
Criar usuário, sendo um administrador | IdentityIntegration | POST /v1/administrators/user | POST | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Editar usuário, sendo um administrador | IdentityIntegration | PUT |
/v1/administrators/user |
PUT |
|
Criar e editar usuario através de um administrador
PUT (Depreciada)
/v1/administrators/user
PUT (nova rota)
/v2/administrators/user
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Consultar documento |
(Autenticação por código |
) | Documents |
GET /v1/publicacoes/sem-cadastro/{id} | GET |
|
Importante: a rota depreciada não retorna documentos em status Cancelado. 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 |
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
/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
Realizar assinatura
(Autenticação por código / Sem cadastro)
Signintegration
DELETE
/v2/publicacoes
DELETE
documents/v1/publicacoes/{id}
Excluir publicação
Signintegration
DELETE
/v2/publicacoes
POST
documents/v1/publicacoes/{id}/cancelar
...
| title | Histórico completo |
|---|
...
POST (antiga)
signintegration/v2/Publicacoes
POST (nova)
documents/v1/publicacoes
06/12/24
...
POST (Depreciada)
/v2/Assinaturas/sem-cadastro
POST (Nova)
/v2/Assinaturas/sem-cadastro
...
GET (Depreciada)
/v1/publicacoes/sem-cadastro/{id}
GET (nova rota)
/v2/publicacoes/sem-cadastro/{id}
...
| Adição de regra para validar assinaturas manuscritas. | ||||||
Excluir documento | Signintegration | DELETE /v2/publicacoes | DELETE (Documents) |
| 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 /v2/publicacoes | POST (Documents) | Importante: a rota depreciada foi 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. | ||
Consultar contato | Contact | GET /v1/contatos | GET |
| Alterações no Payload (contrato da API) e no Response (dados retornados). | |
Remover contato | Contact | DELETE /v1/contatos | DELETE | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Alterar contato | Contact | PUT /v1/contatos | PUT | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Listar todos contatos | Contact | GET /v1/contatos/usuario | GET | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Incluir contato em grupo | Contact | POST /v1/contatos-grupo | POST | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Remover contatos de grupo | Contact | DELETE /v1/contatos-grupo | DELETE | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Remover contato de grupo | Contact | DELETE /v1/contatos-grupo | DELETE | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Consultar grupo | Contact | GET /v1/grupos | GET | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Listar todos grupos | Contact | GET |
...
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
...
/v1/grupos/usuario | GET |
...
...
DELETE (nova)
/v2/contatos/{id}
PUT (nova)
/v2/contatos/{id}
GET (nova)
/v2/contatos
GET (nova)
/v2/grupos/{id}
| Alterações no Payload (contrato da API) e no Response (dados retornados). | |||
Alterar grupo | Contact | PUT /v1/grupos | PUT |
...
DELETE (nova)
/v2/grupos/{id}
GET (nova)
/v2/grupos
POST (nova)
/v1/grupos/{id}/contatos
| Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Remover grupo | Contact | DELETE |
...
/v1/grupos |
...
DELETE |
...
...
...
...
| Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
| Upload de documentos | Storage | POST |
/api/Storage/list | POST ( |
...
Documents) |
...
...
...
| 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 |
...
| 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) |
| Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço. | |
Download de documento | Storage | GET /v1/Storage | GET (Documents) | 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) | 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 |
...
...
...
| Importante: a rota depreciada não retorna documentos em status Cancelado. | ||
Listar e filtrar documentos | SignIntegration | GET /v2/publicacoes/ |
...
filter |
...
POST (Documents) |
...
...
...
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 /v2/publicacoes/filter-basic | POST (Documents) |
...
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 | Documents | POST /v1/publicacoes/pesquisas | POST |
...
...
Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados). | ||||
Listar e filtrar documentos | Documents | POST /v2/publicacoes/pesquisas | POST |
...
| Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Listar e filtrar documentos | Documents | POST / |
...
v3/ |
...
publicacoes/pesquisas | POST |
...
...
...
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas