• Guia do Cliente
▫️Métodos disponíveis na API
A ArqSign conta atualmente com seis métodos disponíveis para uso na plataforma, dentre eles temos alguns que já foram reformulados e atualizados para a versão 2.
| Nº | TAG | Método | Descrição | Versão | Status |
|---|---|---|---|---|---|
| 0.0 | Processo | POST/api/v1/processo/enviar-documento-para-assinar | Enviar processo de assinaturas | 1 | Descontinuado. Utilizar V2. |
| 0.0 | Processo | GET/api/v1/processo/{idprocesso} | Buscar informações do processo de assinaturas | 1 | Descontinuado. Utilizar V2. |
| 0.0 | Processo | PATCH/api/v1/processo/{idProcesso}/reenviar-processo | Editar e Reenviar o processo para os destinatários pendentes de assinaturas | 1 | Descontinuado. Utilizar V2. |
| 1.1 | Processo | POST/api/v2/processo/enviar-documento-para-assinar | Enviar processo de assinaturas | 2 | Disponível |
| 1.1.1 | Processo | POST/api/v3/processo/enviar-documento-para-assinar | Enviar processo de assinaturas | 3 | Disponível |
| 1.2 | Processo | GET/api/v2/processo/{idProcesso} | Buscar informações do processo de assinaturas | 2 | Disponível |
| 1.3 | Processo | PATCH/api/v2/processo/{idProcesso}/reenviar-processo | Editar e Reenviar o processo para os destinatários pendentes de assinaturas | 2 | Disponível |
| 1.4 | Processo | GET/api/v1/processo/{idProcesso}/status-do-processo | Buscar status do processo de assinaturas | 1 | Disponível |
| 1.5 | Processo | GET/api/v1/processo/{idprocesso}/dados-signatarios | Buscar dados dos signatários | 1 | Disponível |
| 1.6 | Processo | PATCH/api/v1/processo/{idProcesso}/cancelar-processo | Cancelar o processo de assinaturas | 1 | Disponível |
| 1.7 | Processo | POST/api/v1/processo/{idProcesso}/buscar-anexos-signatarios | Buscar anexos dos signatários do processo de assinaturas | 1 | Disponível |
| 1.8 | Processo | GETapi/v1/processo/{idArquivoProcesso}/registro-assinaturas | Buscar registro de assinatura de um documento | 1 | Disponível |
| 2.1 | Diretórios | POSTapi/v1/diretorio/buscar-pastas | Buscar dados das pastas da conta | 1 | Disponível |
| 3.1 | Usuários | POSTapi/v1/usuarios/buscar-usuarios | Buscar dados dos usuários da conta | 1 | Disponível |
| 4.1 | Conta | GETapi/v1/conta/papeis-signatarios | Buscar dados dos papéis de signatários da conta | 1 | Disponível |
| 4.2 | Conta | POSTapi/v1/conta/buscar-consumo-itens-assinatura | Buscar o uso e consumo dos itens da assinatura da conta | 1 | Disponível |
| 4.3 | Conta | GETapi/v1/conta/dados-assinatura | Buscar os dados da assinatura da conta | 1 | Disponível |
| 5.1 | Webhook | PATCHapi/v1/confwebhook/{idConfWebHook}/alterar-status | Alterar o status da configuração de Webhook | 1 | Disponível |
| 5.2 | Webhook | POSTapi/v1/confwebhook | Cadastrar configuração de Webhook | 1 | Disponível |
| 5.3 | Webhook | GETapi/v1/confwebhook | Buscar as configurações de Webhook da conta | 1 | Disponível |
Todos os métodos que retornam campos de data e hora na API estão no fuso horário UTC+0.
Atualizado há 13 dias