Documentation

Authentication

Get Pronto uses API keys to authenticate requests. You can view and manage your API keys from your Get Pronto Dashboard.

Getting Your API Key

To access the Get Pronto API, you'll need an API key. Here's how to get one:

  1. Log in to your Get Pronto Dashboard
  2. Navigate to the API Keys section
  3. Click Create New API Key
  4. Give your key a name (e.g., "Development", "Production")
  5. Copy your new API key - note that it will only be shown once

Important: Your API keys carry many privileges, so be sure to keep them secure. Don't share your API keys in publicly accessible areas such as GitHub, client-side code, etc.

Authenticating with the SDK

When using the Get Pronto SDK, you'll need to provide your API key during client initialization:

javascript
import GetProntoClient from "@getpronto-io/getpronto-sdk";

// Initialize the client with your API key
const client = new GetProntoClient({
  apiKey: "YOUR_API_KEY",
  baseUrl: "https://api.getpronto.io/v1" // Optional, defaults to this
});

// Now you can use the client for authenticated requests
const files = await client.files.list();

Authenticating REST API Requests

For direct REST API requests, include your API key in the request headers:

bash
curl https://api.getpronto.io/v1/files \
  -H "ApiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Request Headers

HeaderDescriptionRequired
ApiKeyYour Get Pronto API keyYes
Content-TypeThe content type of the request body (for POST/PUT requests)Conditional
AcceptThe format of the response you want to receive (defaults to application/json)No

API Key Security

To use your API key securely in your applications, we recommend the following best practices:

  • Store API keys in environment variables or a secure key management system
  • Never hardcode API keys in your application source code
  • Don't store API keys in files inside your application's source tree
  • Regenerate API keys periodically
  • Use different API keys for different environments (development, testing, production)

Note: For client-side applications, we recommend creating a secure backend service to make API calls to Get Pronto, rather than embedding your API key in client-side code.

Next Steps

Continue exploring our documentation with these related topics: