Get Pronto uses API keys to authenticate requests. You can view and manage your API keys from your Get Pronto Dashboard.
To access the Get Pronto API, you'll need an API key. Here's how to get one:
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.
When using the Get Pronto SDK, you'll need to provide your API key during client initialization:
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();
For direct REST API requests, include your API key in the request headers:
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.
Header | Description | Required |
---|---|---|
ApiKey | Your Get Pronto API key | Yes |
Content-Type | The content type of the request body (for POST/PUT requests) | Conditional |
Accept | The format of the response you want to receive (defaults to application/json) | No |
To use your API key securely in your applications, we recommend the following best practices:
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.
Continue exploring our documentation with these related topics: