To securely access and interact with the Cauzioni Digitali platform, an API Key is required. This key serves as your identification for all transactions and interactions with the platform’s services. Follow the steps below to request and implement API Key authorization in your applications.
The API Key can be obtained by submitting a request to Surety Shield. To initiate this process, contact the support team via email, providing your company details and the intended use case for the API. Upon approval, Surety Shield will issue a unique API Key for your applications to use.
Once you have received your API Key, it must be included in the Authorization header of every HTTP request made to the platform. This key authenticates and authorizes your access to the Cauzioni Digitali API. Below are examples demonstrating how to include the API Key in requests using different programming languages.
Curl Example
curl -X GET '{base_endpoint}/ping' \
-H 'Authorization: YOUR_API_KEY'Ensure the YOUR_API_KEY placeholder is replaced with the actual API Key provided by Surety Shield. For security reasons, never expose your API Key in publicly accessible areas such as GitHub or client-side code that can be easily viewed by others.
Secure Storage: Always store your API Key in a secure location to prevent unauthorized access.
Regenerate Keys: If you suspect that your API Key has been compromised, contact CETIF Advisory immediately to issue a new key.
Environment Variables: Consider using environment variables to store your API Key in development and production environments.