Este serviço permite aos Clientes, via API, buscar as configurações de webhook da conta.

Validações

Validações Gerais

Autenticação

1. Para autenticar na API da ArqSign, o usuário deve informar a AppKey e SubscriptionKey da conta que está buscando as configurações de webhook.
2. O sistema valida se a AppKey existe e é válida.
3. Somente conta com status Ativo pode buscar configurações de Webhook via integração ArqSign.
4. O sistema valida se o plano da assinatura vigente da conta possui a permissão de Integração ArqSign. (10.1 Usar Integração ArqSign)
5. O sistema verifica se SubscriptionKey pertence a conta da AppKey informada (SubscriptionKey1 ou SubscriptionKey2).
a. Se sim, o sistema busca as configurações de Webhook da conta com a flag ArqGED igual a 0 = False.
b. Se não, retorna erro 401 – Unauthorized.

Retorno Validações

Erro: 400 – Bad Request

Este erro é retornado quando não for possível interpretar a requisição e/ou o servidor tenta processar a solicitação, mas algum parâmetro da solicitação não é válido, por exemplo, um recurso formatado incorretamente ou uma tentativa de requisição com dados faltantes. As informações sobre a solicitação são fornecidas no corpo da resposta e incluem um código de erro e uma mensagem de erro.

1. Item obrigatório: Esta mensagem é exibida no singular ou plural quando um ou mais itens obrigatórios não tiver sido enviado na chamada da API.

O(s) item(ns) listado(s) é(são) obrigatório(s): “nome dos itens separados por vírgula”.
2. Formato incorreto: Esta mensagem é exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto.

O(s) item(ns) listado(s) está(ão) com o formato incorreto: “nome dos itens separados por vírgula”.
3. Ids inexistente: Esta mensagem é exibida no singular ou plural quando um ou mais Id enviado não existir.

O(s) id(s) listado(s) não existe(m): “nome dos itens que são Ids de tabela, separados por vírgula”.
4. Algum parâmetro está incorreto ou é inexistente: Esta mensagem é exibida quando a chamada é feita com algum parâmetro escrito errado ou quando é enviado uma informação que não existe no método.

Algum parâmetro está incorreto ou é inexistente.

Erro: 401 – Unauthorized

Este erro é retornado quando

• A chave de autenticação da API ArqSign está incorreta ou não foi informada corretamente.
• Conta está com status diferente de Ativo.

Erro: 404 – Not Found

Este erro é retornado quando o recurso solicitado ou o endpoint não foi localizado.

Erro: 500 – Server Error

Este erro é retornado quando:

• Ocorre um erro interno no servidor.
• Ocorre uma falha na plataforma ArqSign.
• Formato do parâmetro incorreto.
• Formato do JSON incorreto.

Retorno Sucesso

Status 200 – Success

O sistema retorna as configurações de Webhook da conta, ordenadas pelo nome.

Dados da Configuração de Webhook

1. id O sistema retorna o id da configuração de webhook
2. nome O sistema retorna o nome da configuração de webhook
3. status O sistema retorna o status da configuração de webhook. 1 = Ativo 2 = Inativo 3 = Inativo por falhas
4. urlPublicar O sistema retorna a URL para publicação do retorno do webhook.
5. aguardaRetorno O sistema retorna se a configuração de webhook está configurada para aguardar retorno. 1 – True ou 0 – False
6. hmac O sistema retorna a chave HMAC da configuração de webhook.
7. usuários O sistema retorna os Id’s dos usuários da configuração de webhook, se houver.
8. Grupos O sistema retorna os Id’s dos grupos da configuração de webhook, se houver.
9. pasta O sistema retorna os Id’s das pastas da configuração de webhook, se houver.
10. Gatilhos Neste objeto o sistema retorna os dados dos gatilhos da configuração de webhook. Uma configuração de webhook pode ter até 8(oito) gatilhos configurados. 1 – Processo enviado 2 – Processo com falha de envio 3 – Processo assinado por algum signatário 4 – Processo recusado por algum signatário 5 – Processo cancelado pelo remetente 6 – Processo expirado 7 – Processo reenviado 8 – Processo assinado/concluído por todos os signatários

id

O sistema retorna o id do gatilho da configuração de webhook.

nome

O sistema retorna o nome do gatilho da configuração de webhook.

ativo

O sistema retorna se o gatilho da configuração de webhook está ativo ou não (true ou false).

1. dadosRetorno Neste objeto o sistema retorna os dados de retorno da configuração de webhook.

processo O sistema retorna se a configuração de webhook está configurada para retornar os dados do processo. 1 – True ou 0 – False

signatários O sistema retorna se a configuração de webhook está configurada para retornar os dados dos signatários. 1 – True ou 0 – False

documentos O sistema retorna se a configuração de webhook está configurada para retornar os documentos do processo. 1 – True ou 0 – False

documentosTipo O sistema retorna o formato dos documentos do processo que serão retornados. 1 = Base64 ou 2= Link para download

linkDocumentoCompartilhado O sistema retorna se a configuração de webhook está configurada para retornar o link de compartilhamento dos documentos do processo. 1 – True ou 0 – False Obs.: O processo terá o link de compartilhamento somente se estiver concluído.

registrosAssinatura O sistema retorna se a configuração de webhook está configurada para retornar os registros de assinaturas dos documentos do processo. 1 – True ou 0 – False

registrosAssinaturaTipo O sistema retorna o formato dos registros de assinaturas dos documentos do processo que serão retornados. 1 = Base64 ou 2= Link para download

Retorno – Exemplo Body Response

[
    {
        "id": "guid",
        "nome": "string",
        "status": "tinyint",
        "urlPublicar": "string",
        "aguardaRetorno": "bit",
        "hmac": "string",
        "usuarios": [
            "guid",
            "guid"
        ],
        "grupos": [
            "guid"
        ],
        "pastas": [
            "guid"
        ],
        "gatilhos": [
            {
                "id": "tinyint",
                "nome": "string",
                "ativo": "bit"
            }
        ],
        "dadosRetorno": {
            "processo": "bit",
            "signatarios": "bit",
            "documentos": "bit",
            "documentosTipo": "byte",
            "linkDocumentoCompartilhado": "bit",
            "registrosAssinatura": "bit",
            "registrosAssinaturaTipo": "byte"
        }
    }
]