Getting started overview
This guide outlines the initial steps for integrating Hashable's API security platform. Hashable provides capabilities for proactive API threat detection, real-time API anomaly detection, and automated API attack blocking. The platform also offers tools for API policy enforcement to maintain security standards. The process typically involves creating an account, obtaining necessary API credentials, and configuring your first API request to route through Hashable for security analysis and protection. Hashable is designed to provide visibility and control over API traffic, identifying and mitigating risks before they impact services.
The core products offered by Hashable center around its API Security Platform, which includes features for monitoring, detecting, and responding to threats against APIs. Hashable aims to simplify the deployment and management of API security, providing developers with tools to protect their API ecosystem efficiently. For a comprehensive understanding of all features, refer to the Hashable official documentation.
Before proceeding, ensure you have:
- Access to an email address for account registration.
- Basic familiarity with your API infrastructure (e.g., API Gateway, proxy).
- A development environment capable of making HTTP requests (e.g., cURL, Postman, a programming language).
Create an account and get keys
To begin using Hashable, the first step is to create an account on their platform. Hashable offers a Developer Plan, which allows users to secure up to 10 APIs and process up to 5 million API calls per month without charge, making it suitable for initial evaluations and smaller projects. For higher usage or advanced features, paid plans such as the Growth Plan or Enterprise Plan are available, with the Growth Plan starting at $500/month.
Account registration
- Navigate to the Hashable homepage.
- Locate and click the "Sign Up" or "Get Started" button.
- Provide the required information, typically including your email address and a strong password.
- Follow any email verification steps to activate your account.
Obtaining API credentials
After successful account creation and login, you will need to generate or locate your API credentials. These credentials are vital for authenticating your API traffic with the Hashable platform. Hashable's API security platform integrates by acting as a proxy or by integrating with existing API gateways. The specific credentials needed will depend on the integration method chosen, but commonly include API keys or client secrets.
- From your Hashable dashboard, navigate to the "API Keys" or "Settings" section.
- Generate a new API key pair or retrieve existing keys. These keys typically consist of a public key (or client ID) and a secret key.
- Store your secret key securely. It should not be hardcoded into client-side applications or exposed in public repositories. Treat it with the same security considerations as other sensitive credentials, such as those used for Stripe API keys or PayPal API authentication.
- Note down the API endpoint or proxy URL provided by Hashable. This is where your API traffic will be directed.
Your first request
Making your first request through Hashable involves configuring your existing API calls to route through Hashable's security platform. This typically means updating your API client or gateway to point to Hashable's proxy endpoint and including your API credentials for authentication. The goal is to observe Hashable's real-time detection capabilities in action.
Example: Protecting an existing API endpoint
Assume you have an existing API endpoint at https://your-api.com/data that you want to protect. After setting up Hashable, you will receive a Hashable proxy endpoint, for example, https://hashable-proxy.com/your-api-id/data. Your client applications will then send requests to this Hashable proxy endpoint.
Using cURL for a protected request
To demonstrate a basic request, you can use cURL. Replace YOUR_HASHABLE_API_KEY and YOUR_HASHABLE_SECRET_KEY with your actual credentials, and https://hashable-proxy.com/your-api-id/data with your Hashable-provided proxy endpoint.
curl -X GET \
-H "X-Hashable-Client-ID: YOUR_HASHABLE_API_KEY" \
-H "X-Hashable-Client-Secret: YOUR_HASHABLE_SECRET_KEY" \
"https://hashable-proxy.com/your-api-id/data"
Upon sending this request, Hashable intercepts it, applies its security policies, and then forwards it to your original backend API. The response is then returned to your client, potentially after Hashable has performed additional security analysis or modifications.
Integration with API Gateways
For production environments, integrating Hashable with an API Gateway (e.g., Kong Gateway, AWS API Gateway, Google Cloud Endpoints) is a common pattern. This involves configuring the gateway to forward traffic to Hashable's platform. For instance, with AWS API Gateway, you might configure an HTTP proxy integration to send requests to your Hashable endpoint. Similarly, Kong Gateway can be configured with plugins to route traffic through external services.
Common next steps
Once your initial request is successful, you can proceed with further integration and configuration to fully leverage Hashable's API security capabilities.
Configure API definitions
Hashable can import your API definitions (e.g., OpenAPI/Swagger specifications) to understand your API surface. This allows for more precise anomaly detection and policy enforcement. Uploading your API definitions helps Hashable identify legitimate API behavior and detect deviations more effectively. For details on how to prepare and upload your specifications, consult the Hashable API Definition documentation.
Set up custom security policies
Beyond default protections, Hashable allows you to define custom security policies. These policies can specify rules for rate limiting, IP whitelisting/blacklisting, data validation, and more. Custom policies enable you to tailor Hashable's protection to the specific security requirements of your APIs. Refer to the Hashable Custom Policies guide for detailed instructions.
Integrate with SIEM/observability tools
For comprehensive security operations, integrate Hashable's alerts and logs with your Security Information and Event Management (SIEM) or observability platforms. This allows you to centralize security monitoring and respond to incidents efficiently. Hashable often supports integrations with popular tools via webhooks or direct connectors. Information on integrating Hashable with other systems is typically found in the Hashable Integrations section of the documentation.
Monitor API traffic and alerts
Regularly review the Hashable dashboard to monitor API traffic, identify potential threats, and respond to security alerts. The dashboard provides insights into API usage patterns, detected anomalies, and blocked attacks, offering a real-time overview of your API security posture.
Troubleshooting the first call
Encountering issues during the initial setup is common. Here are some steps to diagnose and resolve problems with your first Hashable-protected API call.
| Step | What to Do | Where to Check |
|---|---|---|
| 1. Check API Credentials | Verify that the X-Hashable-Client-ID and X-Hashable-Client-Secret are correct and match the keys generated in your Hashable dashboard. Ensure there are no leading/trailing spaces. |
Hashable dashboard > API Keys section; your client code/cURL command. |
| 2. Verify Hashable Endpoint | Confirm that the URL you are sending requests to is the correct Hashable proxy endpoint, including your specific API ID if applicable. | Hashable dashboard > API Configuration; your client code/cURL command. |
| 3. Network Connectivity | Ensure your development environment has outbound internet access to reach the Hashable proxy endpoint. Check firewall rules if applicable. | Local network configuration; try pinging hashable-proxy.com (or similar) if allowed. |
| 4. Hashable Dashboard Logs | Check the Hashable dashboard for any error messages or blocked requests related to your API. Hashable logs provide insights into why a request might have been rejected or not forwarded. | Hashable dashboard > Logs/Alerts section. |
| 5. Original API Endpoint Status | Confirm that your original backend API is operational and accessible from the internet (or from where Hashable would access it). Hashable forwards requests, so the backend must be healthy. | Directly test your original API endpoint without Hashable in between. |
| 6. SSL/TLS Issues | If you are using custom domains or specific SSL certificates, ensure they are correctly configured in both your environment and Hashable. | Hashable documentation on SSL/TLS configuration; your server's SSL setup. |
| 7. Rate Limits/Policy Blocks | If you've configured custom policies, ensure your test request isn't inadvertently triggering a rate limit or other blocking policy. | Hashable dashboard > Policies section; adjust test request volume. |
For more specific troubleshooting steps, refer to the Hashable troubleshooting documentation or contact Hashable support through their official channels.