Desenvolvedor de sinal OneSpan: recuperar pacotes de remetentes

Duo Liang, 1 de Agosto de 2018
Thumbnail

Neste blog, mostrarei o que você pode ter perdido na Comunidade de desenvolvedores do OneSpan Sign durante a semana de 22 de julho de 2018. Hoje, estamos cobrindo as diferenças entre proprietários e remetentes de contas. Sem mais delongas, vamos começar.


Proprietário da conta x remetente

Como proprietário da conta, o OneSpan Sign fornece a capacidade de adicionar remetentes à sua conta principal, permitindo que eles criem e enviem pacotes de documentos. 
Existem algumas diferenças entre o proprietário da conta e o remetente:

 

  1. Como proprietário da conta, na interface da Web da Web, quando você clica na lista suspensa ao lado do seu nome na parte superior da tela, verá sua função como "Gerente". Remetentes comuns, no entanto, serão padronizados para a função de "Membro".
     
  2. Somente um proprietário da conta tem a opção "Admin" nesta lista suspensa. No entanto, o que discutiremos neste blog é que apenas um proprietário da conta pode recuperar uma chave de API. Os remetentes não podem obter chaves diretamente pela interface da Web. Isso significa que os remetentes não podem enviar uma chamada de API ou chamar as próprias funções do SDK.

 

Como recuperar os pacotes e informações do remetente

Como proprietário da conta, você deve estar se perguntando como gerenciar pacotes, modelos e layouts para remetentes, pois eles não podem recuperar suas informações programaticamente. Abaixo está um guia passo a passo para gerenciar esses elementos. 

1 Recuperar a chave de API do remetente

Para recuperar essas informações, você precisa obter a chave de API do remetente e usar esse token para chamar APIs exatamente como o que você fez com sua conta de proprietário principal. Há duas etapas para conseguir isso:

Primeiro, você recuperaria o (s) ID (s) do remetente de uma das duas maneiras. A seguir, você receberá os 50 primeiros remetentes da sua conta, os quais você poderá percorrer para acessar os IDs dos remetentes:

GET https://sandbox.esignlive.com/api/account/senders?from=0&to=50.

 

Se você estiver interessado apenas em um único remetente, poderá fazer uma pesquisa direta por esse remetente com a seguinte chamada:

GET https://sandbox.esignlive.com/api/account/senders?search={signerEmail}

 

Depois de ter o ID do remetente, você pode usar a API abaixo para recuperar a chave da API do remetente atual. Embora mencionemos que os remetentes não podem ver suas chaves de API, o OneSpan Sign tem uma chave atribuída a cada remetente e, como proprietário da conta, você pode recuperá-las:

GET https://sandbox.esignlive.com/api/account/senders/{senderId}/apiKey 

 

Observe que, atualmente, esta função está disponível apenas através da API REST.

 

2)    Recuperar lista de layouts

GET / api / layouts? From = {fromLayout} e para = {toLayout}


Autorização: básica {chave da API do remetente}


3)    Recuperar lista de IDs de pacotes

Você pode usar a seguinte chamada de API para recuperar pacotes diretamente para um remetente específico. Lembre-se de que essa chamada à API retornará apenas pacotes criados sob o proprietário da conta principal se você estiver usando a chave de API do proprietário. Então, em vez disso, você deve colocar a chave do remetente no cabeçalho da solicitação. 


GET / api / packages? Query = {status} & from = {fromPackage} & to = {toPackage}

Autorização: básica {chave da API do remetente}


Como alternativa, você pode simplesmente usar o Recurso Relatório de Conclusão para recuperar todos os IDs de pacotes de remetentes. Usando essa estratégia, você não precisa necessariamente obter a chave de API do remetente.

GET / api / reports / conclusão? Status = {status} & from = {fromDate} & to = {toDate}
Autorização: básica {chave do proprietário da conta}

 

Pesquisa por palavras-chave


O OneSpan Sign oferece a capacidade de filtrar os resultados recuperados por palavras-chave. Você pode simplesmente adicionar um parâmetro "& search = {keyword}" à sua chamada à API para os três cenários a seguir:


Para recuperar pacotes:
GET / api / packages? Search = {keyword} & from = {fromPackage} & to = {toPackage}

 

Para recuperar modelos:
GET / api / packages? Type = TEMPLATE & search = {keyword} & from = {fromTemplate} & to = {toTemplate}


Para recuperar layouts:
GET / api / layouts? Search = {keyword} & from = {fromLayout} & to = {toLayout}

 

Aviso prévio:


1 Modelo é um tipo de pacote com o tipo de "modelo"

2) Em uma URL, o valor dos parâmetros de palavra-chave e tipo (que é o modelo aqui) não faz distinção entre maiúsculas e minúsculas. Ao contrário do parâmetro status, que indica o status do pacote. Por exemplo, “DRAFT” ou “SENT” deve ser escrito em letras maiúsculas.

3) "De" e "para" nas pesquisas acima são números inteiros correspondentes à ordem do pacote / modelo / layout na lista de elementos.
Como alternativa, você pode usar as funções do SDK junto com os parâmetros relacionados para atingir o mesmo objetivo que não o de recuperar as chaves de API dos remetentes.

 

Se você tiver dúvidas sobre este blog ou qualquer outra coisa relacionada à integração do OneSpan Sign ao seu aplicativo, visite o Fóruns da comunidade de desenvolvedores