ShieldShiba
Bot checks for signup and contact forms.
Bot checks for your signup and contact forms. Each site has a public site key for the widget and a secret key for your server. secret_key is returned on create and rotate_secret, and on show to Admins, not on index or update. allowed_hostnames also takes a comma or space separated string. Subdomains of an allowed hostname pass. block_hosting blocks traffic from hosting and datacenter networks. block_free_email blocks free mailbox providers. require_liveness asks visitors who pass for a camera check: they follow a few random poses and AI confirms a live person, and verify returns reasons ["liveness"]. Visitors without a camera cannot pass it. liveness_on_suspicion asks only visitors who look automated for that camera check, instead of blocking them. allowlist holds IPs, CIDR ranges, email domains, and email addresses that skip every check; it takes an array or a comma, space, or newline separated string, and an update replaces the whole list. A visitor who matches passes with reasons ["allowlisted"]. A visitor can also pass with soft reasons such as ["noisy_network"]: signs of automation that were not enough to block, and that made their browser do more work first. verifications_7d counts passed and blocked checks over the last 7 days. Redeem a widget token from your server with POST /shield/v1/verify.
GET /api/v1/teams/:obfuscated_team_id/shield_sites
List sites. secret_key is omitted.
POST /api/v1/teams/:obfuscated_team_id/shield_sites
Create a site. Returns the public and secret keys.
PATCH /api/v1/shield_sites/:id
Update name, allowed_hostnames, block_hosting, block_free_email, require_liveness, liveness_on_suspicion, or allowlist. secret_key is omitted.
id: Public site id
POST /api/v1/shield_sites/:id/rotate_secret
Issue a new secret key. The old one stops working at once. The site key is unchanged.
id: Public site id
DELETE /api/v1/shield_sites/:id
Delete a site. Widgets using its site key stop passing.
id: Public site id
POST https://app.postshiba.com/shield/v1/verify
Redeem a widget token from your server. No API key. Send the site's secret key, the token, and optionally the email the visitor typed. A token redeems once and expires after 5 minutes. 401 invalid_secret. 422 invalid_token.