Password Pusher API v2
BETADocumentação abrangente da API REST para integrar o Password Pusher em seus fluxos de trabalho, aplicativos e ferramentas.
Aviso de Beta: A API v2 está atualmente em versão beta. Embora tenhamos feito todos os esforços para garantir a estabilidade, pode haver mudanças significativas antes do lançamento final. Seus comentários são bem-vindos!
Visão geral
A API do Password Pusher v2 fornece uma interface RESTful para criar, recuperar e gerenciar solicitações e envios de senhas seguras. Todos os pontos de extremidade da API retornam respostas JSON e usam códigos de status HTTP padrão.
Autenticação de token de portador
Acesso seguro à API com autenticação baseada em token
Respostas somente JSON
Formato JSON consistente em todos os pontos de extremidade
Projeto RESTful
Endpoints REST intuitivos que seguem as práticas recomendadas
Pushes e solicitações
Suporte para push unidirecional e solicitações bidirecionais
Gerador de senhas
Crie senhas, frases-senha e PINs por meio da chamada POST /api/v2/generate
A API v2 usa a autenticação de token do portador. Para autenticar, inclua seu token de API no campo Authorization cabeçalho:
Authorization: Bearer YOUR_API_TOKEN
Obtendo seu token de API
- Faça login em sua conta do Password Pusher
- Navegue até sua página de tokens de API
- Gerar um token de API
- Copie o token e use-o em suas solicitações de API
Observação: Algumas interfaces de programa (como a recuperação de uma notificação push ou solicitação, ou a geração de uma senha) podem ser acessadas anonimamente. A criação de solicitações, o acesso a registros de auditoria e o gerenciamento de coleções exigem autenticação. Inclua um token Bearer nas solicitações de geração quando for necessário seguir a política do espaço de trabalho que exige login.
Todos os pontos de extremidade da API são prefixados com:
https://eu.pwpush.com/api/v2
Disponibilidade Beta
A API v2 está atualmente na versão beta e está disponível em pwpush.com e as edições Pro auto-hospedadas. A API será adicionada à edição de código aberto depois que ela sair da versão beta.
Para instâncias auto-hospedadas, use seu próprio domínio. O URL básico mostrado acima reflete o host atual que você está acessando.
GET /api/v2/version
Retorna a versão atual da API, os detalhes do aplicativo e um hash de recursos que descreve quais recursos estão ativados nessa instância.
Exemplo de solicitação
curl -X GET https://eu.pwpush.com/api/v2/version
Exemplo de resposta
{
"application_version": "2.1.0",
"api_version": "2.1",
"edition": "commercial",
"features": {
"anonymous_access": true,
"api_token_authentication": true,
"password_generator": {
"enabled": true,
"languages": ["de", "en", "es", "fr", "it"]
},
"accounts": {
"enabled": true
},
"pushes": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
},
"requests": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
}
}
}
Características Hash
anonymous_access - Se o uso anônimo da API é permitido
api_token_authentication - Suporte à autenticação por token de portador
password_generator.enabled - Se a geração de senhas, frases-senha e PINs está ativada
password_generator.idiomas - Idiomas suportados para listas de palavras-passe
accounts.enabled - Se a listagem de espaços de trabalho está disponível em /api/v2/workspaces (o caminho legado /api/v2/accounts é um alias)
pushes.enabled - Criação e gerenciamento de push via API
pushes.email_auto_dispatch - Se esta instância pode enviar links secretos por e-mail na criação. Apenas detecção de recurso — use o parâmetro `notify_recipients` na criação para desativar o envio automático, mantendo o uso de `notify_emails_to` para destinatários autenticados.
pushes.file_attachments.enabled - Anexos de arquivos em pushes
pushes.file_attachments.requires_authentication - Os anexos de arquivos exigem autenticação
requests.enabled - Criação e gerenciamento de solicitações via API
requests.email_auto_dispatch - Se esta instância pode enviar links secretos por e-mail na criação. Apenas detecção de recurso — use o parâmetro `notify_recipients` na criação para desativar o envio automático, mantendo o uso de `notify_emails_to` para destinatários autenticados.
requests.file_attachments.enabled - Anexos de arquivos em respostas a solicitações
requests.file_attachments.requires_authentication - Os anexos de arquivos exigem autenticação
POST /api/v2/generate
Cria uma ou mais senhas, frases-senha ou PINs. A autenticação é opcional. As solicitações anônimas utilizam a política do espaço de trabalho principal (ou global auto-hospedado). Envie um token Bearer para utilizar a política do espaço de trabalho com login, inclusive em domínios personalizados.
Quando a configuração do gerador é desativada por política, as substituições de opções são ignoradas e apenas a contagem é considerada.
Se a geração de senha estiver desativada, a API retorna o código de erro 403 (Proibido).
A geração está limitada a 30 solicitações por minuto por endereço IP ou usuário autenticado.
Corpo da solicitação (JSON)
Envie os parâmetros na raiz do objeto JSON. Os campos omitidos assumirão os valores padrão da política em vigor.
| Parâmetro | Tipo | Descrição |
|---|---|---|
workspace_id
opcional
|
string | Espaço de trabalho autenticado a partir do qual a política será aplicada. Também aceita account_id. Retorna 401 se o chamador não for membro desse espaço de trabalho. |
type
opcional
|
string | senha, frase secreta ou PIN |
count
opcional
|
integer (1-10) | Número de valores a serem gerados |
language
opcional
|
string | Lista de senhas: en, es, fr, de ou it |
word_count
opcional
|
integer (3-10) | Número de palavras em uma senha de acesso |
separator
opcional
|
string | Sequência inserida entre as palavras da senha |
capitalize
opcional
|
boolean | Escreva cada palavra da senha com letra maiúscula |
number
opcional
|
boolean | Adicionar dígitos a uma senha |
symbol
opcional
|
boolean | Acrescentar um símbolo a uma senha |
length
opcional
|
integer | Comprimento da senha (4–128) ou comprimento do PIN (4–12) |
uppercase
opcional
|
boolean | Inclua letras maiúsculas nas senhas |
lowercase
opcional
|
boolean | Inclua letras minúsculas nas senhas |
digits
opcional
|
boolean | Inclua dígitos nas senhas |
symbols
opcional
|
boolean | Inclua símbolos nas senhas |
avoid_ambiguous
opcional
|
boolean | Exclua caracteres ambíguos, como 0, O, l e 1 |
min_digits
opcional
|
integer | Número mínimo de dígitos em uma senha |
min_symbols
opcional
|
integer | Número mínimo de caracteres em uma senha |
charset
opcional
|
string | Predefinição de caracteres: ASCII, latim, cirílico ou grego. Qualquer outro valor é tratado como um conjunto de caracteres personalizado. |
Campos de resposta
| Campo | Descrição |
|---|---|
type |
senha, frase secreta ou PIN |
language |
Presente para senhas. A lista de palavras usada para gerar o resultado. |
entropy_bits |
Valor estimado da resistência retornado na resposta. Consulte a entropia como medida da força de uma senha. |
results |
Matriz de strings geradas |
Exemplo de solicitação
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Content-Type: application/json" \
-d '{
"type": "passphrase",
"language": "en",
"word_count": 4,
"count": 2
}'
Exemplo de resposta
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
Exemplo de senha
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "password",
"length": 20,
"symbols": true
}'
Exemplo: Criar e recuperar um push
# Create a push
curl -X POST https://eu.pwpush.com/api/v2/pushes \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"push": {
"payload": "MySecretPassword123",
"expire_after_duration": 6,
"expire_after_views": 3
}
}'
# Retrieve the push
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
Exemplo: Criar uma solicitação e responder
# Create a request
curl -X POST https://eu.pwpush.com/api/v2/requests \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"request": {
"request": "Please provide the API key",
"close_after_duration": 8
}
}'
# Respond to the request
curl -X PATCH https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
-H "Content-Type: application/json" \
-d '{
"request": {
"response": "The API key is: sk_live_1234567890"
}
}'
Estados solicitantes
A API usa códigos de status HTTP padrão:
200 OK
Solicitação bem-sucedida
201 Created
Recurso criado
400 Bad Request
Parâmetros inválidos
422 Unprocessable Entity
Erros de validação ou dados de solicitação inválidos
401 Unauthorized
Autenticação necessária
403 Forbidden
Acesso negado
404 Not Found
Recurso não encontrado
A limitação de taxa é implementada para proteger a API contra abusos e garantir o uso justo para todos os usuários. Os limites de taxa são aplicados por endereço IP e variam de acordo com o tipo de solicitação e o ponto de extremidade.
As solicitações GET do log de auditoria estão limitadas a 15 solicitações por minuto por endereço IP, com um limite de pico de 5 solicitações a cada 10 segundos e 30 solicitações por minuto por usuário autenticado ou token de API.
Respostas de limite de taxa
Quando uma solicitação excede o limite de taxa, a API retorna um 429 Too Many Requests código de status com um Retry-After indicando quando você pode tentar novamente a solicitação.
Melhores Práticas
- Implemente o backoff exponencial quando você receber uma resposta 429
- Respeite o
Retry-Aftervalor do cabeçalho - Cache de respostas quando apropriado para reduzir as chamadas à API
- Operações em lote quando possível, em vez de fazer muitas solicitações individuais
- Monitore o uso da API do seu aplicativo para evitar atingir os limites
Observação: Os limites de taxa são projetados para evitar abusos e, ao mesmo tempo, permitir o uso legítimo. Se encontrar limites de taxa com frequência, considere otimizar sua integração ou entrar em contato com o suporte para discutir seu caso de uso.
Última atualização: November 22, 2026