Testing with Postman

Accessing the Postman Workspace

To get started with testing the SafeSky UAV API, you can access our fully configured Postman workspace with pre-built requests and authentication:

1. Access the Workspace:

   • Visit the SafeSky UAV API Postman Workspace
   • Click Fork Collection to add it to your own Postman workspace

2. What's Included:

   • Pre-configured API requests with HMAC-SHA256 authentication
   • Automatic signature generation using pre-request scripts
   • Sample request bodies and query parameters
   • Environment variables for easy configuration

Setting Up Your Environment

After forking the collection, configure your environment variables:

1. Select the Environment:

   • In the top-right corner of Postman, click on the environment dropdown
   • Select SafeSky UAV API - Sandbox (or create a new environment)

2. Configure Environment Variables:

   • Click the eye icon (👁️) next to the environment dropdown, then click Edit
   • Set the following variables:

   Variable	Initial Value	Current Value
   server	https://sandbox-public-api.safesky.app	https://sandbox-public-api.safesky.app
   ss-api-key	(leave empty)	<your_api_key>

   • Important: Set ss-api-key as a secret type variable to keep your API key secure
   • The Initial Value will be empty when you share the collection, while Current Value contains your personal API key
   • Click Save

3. Verify Environment Selection:

   • Ensure the correct environment is selected in the top-right corner of Postman
   • The environment name should be visible (e.g., "SafeSky UAV API - Sandbox")

Understanding the Authentication

The collection includes a pre-request script that automatically:

• Generates the required HMAC-SHA256 signature for each request
• Sets authentication headers (Authorization, X-SS-Date, X-SS-Nonce, X-SS-Alg)
• Handles timestamp generation for request bodies
• Resolves environment variables in the canonical request

You don't need to manually configure authentication - just ensure your ss-api-key environment variable is set correctly.

Start Testing

Once the environment is configured:

1. Select a Request: Choose any request from the collection (e.g., POST multiple UAV light - return traffic)
2. Review the Request: Check the request body and query parameters
3. Send the Request: Click Send
4. View the Response: The API will return nearby aircraft traffic based on your UAV positions

Available Endpoints

The collection includes the following pre-configured requests:

• POST /v1/uav: Submit single or multiple UAV positions and retrieve nearby traffic
• GET /health: Check API health status
• Additional endpoints for various use cases

Troubleshooting

If you encounter authentication errors:

• Verify your ss-api-key is correctly set in the environment
• Ensure the correct environment is selected in the top-right corner
• Check that server variable points to https://sandbox-public-api.safesky.app
• Review the Postman console for detailed error messages

---