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) |
|
| 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 |
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) |
| . |
Upload de arquivo
POST
/api/Storage
POST
/documents/v1/envelopes/upload
Editar usuário, sendo um administrador | IdentityIntegration | PUT /v1/administrators/user | PUT |
|
|
| Alterações no Payload (contrato da API) e no Response (dados retornados) |
| . |
Download arquivo
GET
/v1/Storage
Consultar documento (Autenticação por código) | Documents | GET / |
v1/publicacoes/sem-cadastro/{id} |
Consulta envelope por id
SignIntegration
GET |
GET
/documents/v2/publicacoes/
|
Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados) |
. |
Consulta envelope por id
Documents
GET
/v1/publicacoes/{id}
GET
/v2/publicacoes/{id}
Buscar e filtrar envelopes
SignIntegration
Realizar assinatura (Autenticação por código) | Signintegration | POST /v2/Assinaturas/sem-cadastro | POST | 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. |
Buscar e filtrar envelopes
SignIntegration
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. |
Buscar e filtrar envelopes
Documents
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 |
Buscar e filtrar envelopes
Documents
POST
/v2/publicacoes/pesquisas
POST
/v4/publicacoes/pesquisas
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Buscar e filtrar envelopes
Documents
Alterar contato | Contact | PUT |
/ |
v1/ |
contatos |
PUT |
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Criar novo usuário, sendo um administrador
Listar todos contatos | Contact | GET |
/v1/ |
contatos/ |
usuario |
GET |
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Editar usuário existente, sendo um administrador
Incluir contato em grupo | Contact | POST |
/v1/ |
PUT
/v2/administrators/user
contatos-grupo | POST |
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Consulta envelope por id
(Autenticação por código)
Documents
Remover contatos de grupo | Contact | DELETE |
/v1/ |
contatos-grupo | DELETE |
GET
/v2/publicacoes/sem-cadastro/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
/v3/Assinaturas/sem-cadastro
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 /v1/grupos/ |
usuario |
GET |
| Alterações no Payload (contrato da API) e no Response (dados retornados). |
Alterar grupo | Contact | PUT /v1/ |
grupos | PUT |
| 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). |
Manipulação de contatos e grupos de agenda
| 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. |
Manipulação de contatos e grupos de agenda
Contact
DELETE
/v1/contatos-grupo
DELETE
/v1/grupos/{id}/contatos
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. |
Manipulação de contatos e grupos de agenda
Contact
DELETE
/v1/contatos-grupo
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. |
Manipulação de contatos e grupos de agenda
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. |
Manipulação de contatos e grupos de agenda
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. |
Manipulação de contatos e grupos de agenda
Contact
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. |
Manipulação de contatos e grupos de agenda
Contact
DELETE
/v1/grupos
DELETE
/v2/grupos/{id}
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. |
Excluir publicação
Signintegration
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) |
. |
Excluir publicação
Signintegration
Listar e filtrar documentos | Documents | POST |
/v2/publicacoes/pesquisas | POST |
| Alterações no Payload (contrato da API) e no Response (dados retornados) |
| . |
Publicar documento
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