Histórico da Página
As release notes listam Nossa documentação de ciclo de vida lista todas as alterações introduzidas por uma versão de API. Use-as para verificar se sua integração é compatível com uma versão de API e quais alterações você pode precisar fazer antes de migrar sua integração.
Todas as atualizações da api dos serviços serão reportadas nesse portal . Novas quando necessário, que podem envolver: novas rotas, novas versões de apis, apis depreciadas API, depreciações e descontinuações, etc.
Documentação completa das apis: Introdução
| Informações | ||
|---|---|---|
| ||
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á descontinuado descontinuada em breve. Rotas depreciadas permanecerão funcionais por no mínimo 12 meses. Após esse período poderão ser inativadas. |
Documentação das apis : https://totvs-sign.readme.io/reference/gettings-started
| Composition Setup | ||||
|---|---|---|---|---|
| deck.tab.active.background = #FFFFFF
deck.tab.inactive.background = #FFFFFF
deck.card . border = 4px black deck.card.background = #F6F9F9 | ||||
| Deck of Cards | ||||
| ||||
| Card | | |||
| ||||
| Informações | ||||
|
| Informações | API | ROTA | Data | Data desativação | Depreciação rotaSignIntegration / Documents | POST (antiga) POST (nova) |
|---|---|---|---|---|---|
| Expandir | |||||
| |||||
| Descrição | API | ROTA | Data | SignIntegration / Documents | POST (antiga) signintegration/v2/Publicacoes POST (nova) documents/v1/publicacoes |
| Exclusão de apis depreciadas do read.me | Todas depreciadas | Todas depreciadas | 19/08/24 | Documents | POST /v1/publicacoes/{id}/leituras23/11/23 | Inclusão de novas rotas.SignIntegration | PUT /v1/Subscricao23/11/23 | Inclusão de novas rotas.IdentityIntegration | POST10/11/23 | Inclusão de APIWebhooks | GET29/08/23 | Inclusão de APISignintegration | /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 | Documents | POST documents/v1/publicacoes/{id}/destinatarios29/05/23 | Depreciação rotaStorage/ Documents | POST (antiga) storage/api/Storage/list POST (nova) documents/v1/envelopes/upload | 23/05/23 | Inclusão APIDocuments | 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 | SignIntegration | POST /v2/Assinaturas/rejeitar-sem-cadastro | 06/04/23 | Inclusão APIIdentityIntegration | 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 | IdentityIntegration | POST /v1/verification-codes/send | 25/11/22 | Inclusão APIIdentityIntegration | POST /v1/verification-codes/validate | 25/11/22 | Inclusão APIDocuments | POST /v1/publicacoes/dashboard/destinatario | 25/11/22 | Inclusão APISignIntegration | POST /v1/publicacoes/destinatario | 25/11/22 | Inclusão APIDocuments | GET /v1/publicacoes/sem-cadastro/{id} | 25/11/22 | Inclusão APIDocuments | GET /v1/publicacoes/sem-cadastro/{id}/download | 25/11/22 | Inclusão APISignIntegration | POST /v2/Assinaturas/sem-cadastro | 25/11/22 | Inclusão de campos opcionaisSignIntegration | POST /v2/Publicacoes | 25/11/22 | Inclusão de campos opcionaisSignIntegration | POST /v2/Publicacoes/destinatario-list | 25/11/22 | Inclusão API | Documents | POST /v1/publicacoes/pesquisas27/04/22 | Depreciação Rotas | Storage | POST27/04/22 | Depreciação Rotas
| |||||
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 | Alterações no Payload (contrato da API) e no Response (dados retornados). | ||
Editar usuário, sendo um administrador | IdentityIntegration | PUT /v1/administrators/user | PUT |
|
| 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 | 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 /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). | ||
| 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