Seções deste artigo:
Status das solicitações de assinaturas
Retornos de chamada de aplicativos
Uso de solicitações de assinatura
Modo ao vivo e modo de teste
Antes de iniciar o aplicativo, você pode testar as solicitações no modo de teste. Dessa forma, você pode determinar se o fluxo de trabalho está organizado da maneira desejada e pode lidar com comportamentos inesperados antes de mudar para o modo ao vivo.
Para visualizar as solicitações feitas no modo de teste, clique no botão para alternar entre o modo ao vivo e o modo de teste. Você pode reativar o modo ao vivo para preencher o Painel de API com eventos do site on‑line.
Estatísticas
A aba Estatísticas oferece uma visão geral dos dados da sua API. No hub principal, você pode ver rapidamente as solicitações de API, o status das solicitações de assinatura e o uso das solicitações de assinatura na forma de gráficos. Você pode personalizar a visualização da linha do tempo desses dados com base no tipo de dados, intervalo de datas e status do erro (distribuição de erros da API, endpoint ou status HTTP) usando o menu suspenso da parte superior da página. Você também pode verificar registros de atividades de aplicativos e contas.
Na aba Estatísticas, você também pode visualizar a cota usada (solicitações de assinatura restantes) e informações básicas de faturamento.
Status das solicitações de assinaturas
Na aba Status das solicitações de assinaturas, você pode visualizar seus documentos de identificação, status de solicitação de assinatura e datas e horários de eventos. As informações disponíveis nessa página podem ser filtradas por data e status da solicitação de assinatura usando o menu suspenso da parte superior da página.
Retornos de chamada de aplicativos
A aba Retorno de chamada do aplicativo ajuda a configurar e monitorar as interações da interface do usuário (IU), fornecendo uma imagem detalhada do envolvimento dos recursos integrados.
Os retornos de chamada do aplicativo são acionados quando ocorre uma ação agendada (também conhecida como “evento”) associada a um aplicativo específico. As informações coletadas nessa aba mostrarão apenas solicitações integradas.
Saiba mais sobre retornos de chamada e como configurá‑los no Painel de API do Dropbox.
Retornos de chamada da conta
A aba Retorno de chamada da conta ajuda a configurar e monitorar eventos do servidor para proporcionar um fluxo de trabalho simplificado e latência mínima.
Os retornos de chamada da conta enviam uma notificação ao aplicativo quando ocorre um evento envolvendo a conta. Especificamente, eles enviam a carga útil do evento para a URL de retorno de chamada da conta, que é quando todos os dados contidos no evento são gerados. Você pode filtrar retornos de chamada da conta por data ou tipo de evento clicando nos menus suspensos.
É possível configurar a URL de retorno de chamada da conta por meio da chamada da API da conta ou manualmente na página Configurações.
Saiba mais sobre retornos de chamada e como configurá‑los no Painel de API do Dropbox.
Solicitações de API
A aba Solicitações de API fornece uma visão geral da funcionalidade das solicitações enviadas para que você possa procurar e resolver rapidamente quaisquer erros relacionados à solicitação.
As solicitações de API podem ser filtradas por data, status HTTP, método e endpoint por meio do menu suspenso na parte superior da página.
Os códigos HTTP representam o status das interações entre o navegador e o servidor. Com o Painel de API, você pode filtrar solicitações por código de status HTTP para identificar solicitações que precisam de atenção e aquelas que estão funcionando conforme o esperado.
Descrição dos status HTTP:
- O status Informational (Informativo) indica que o servidor ainda não concluiu a solicitação (códigos 100-199).
- O status Success (Sucesso) indica que a solicitação do servidor foi concluída sem erros (códigos 200-299).
- O status Redirectional (Redirecionamento) indica que a solicitação foi recebida, mas depois redirecionada para outro lugar (códigos 300-399).
- O status Client error (erro do cliente) indica que não foi possível acessar a página. Este é um erro do site e geralmente ocorre quando a página não existe no site (códigos 400-499).
- O status Server error (erro do servidor) ocorre quando uma solicitação válida foi feita, mas o servidor não conseguiu concluí‑la conforme o esperado (códigos 500-599).
Você também pode filtrar solicitações de assinatura por método:
- GET (OBTER) é usado para recuperar ou ler um recurso.
- POST (POSTAR) é usado para criar um novo recurso.
- DELETE (EXCLUIR) é usado para excluir todo o recurso.
- PUT (COLOCAR) é usado para modificar todo o recurso.
- PATCH (CORRIGIR) é usado para modificar parte do recurso.
Para filtrar solicitações por endpoint:
- Crie outros parâmetros de solicitação (data, status HTTP, método) necessários para esta visualização.
- Clique em Endpoint.
- Clique em Personalizar.
- Clique na caixa ao lado de qualquer endpoint aplicável.
- Clique em Aplicar.
A lista de endpoints está disponível na visão geral das solicitações de assinatura.
Uso de solicitações de assinatura
As solicitações de assinatura podem ser usadas para fazer referência a dados específicos da solicitação, incluindo nome e endereço de e‑mail dos signatários, campos personalizados, metadados, dados de resposta e carimbos de data e hora de criação e conclusão de assinatura. Você pode filtrar os dados de uso por data e ID do cliente.
Observação: O uso da solicitação de assinatura também aparecerá como um gráfico na página Estatísticas.
Aplicativos e chaves
A aba Aplicativos e chaves redireciona você para a página Configurações, onde você pode visualizar e gerenciar seus aplicativos conectados e chaves de API.
Saiba mais sobre como criar e gerenciar várias chaves de API.
Download em CSV
A aba Download em CSV exibe o histórico de solicitações de assinatura da sua conta dentro de um intervalo de datas personalizado. Você pode exportar essa lista para um arquivo .csv.
Para fazer isso:
- Entre no Dropbox Sign.
- Clique em API.
- Clique em Exibir Painel de API.
- Clique em Download em CSV.
- Insira o intervalo de datas que deseja exportar.
- Clique em Baixar CSV.
Acesse o Painel do Dropbox Sign API para começar.
Recursos relacionados
- Para saber mais sobre os recursos disponíveis e como usar o Painel de API, consulte nosso guia do Painel de API.
- Para saber mais sobre como configurar e executar o Dropbox Sign API, consulte nosso guia de início rápido da API.
Para tirar dúvidas ou relatar um problema, envie uma solicitação aqui.
Comentários
0 comentário
Artigo fechado para comentários.