Skip to main content

Testing with Postman

ImportingAccessing the Postman CollectionWorkspace

To get started with testing the SafeSky UAV API, followyou thesecan stepsaccess toour importfully the providedconfigured Postman Collection:workspace with pre-built requests and authentication:

  1. Open Postman: LaunchAccess the Workspace:

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

    ImportWhat's the CollectionIncluded:

    • ClickPre-configured onAPI therequests Importwith buttonHMAC-SHA256 in the top left corner of Postman.authentication
    • PasteAutomatic thesignature followinggeneration URLusing postmam_collection.jsonpre-request scripts
    Sample request bodies and clickquery Continueparameters toEnvironment completevariables thefor import.easy configuration

    Setting Up AuthorizationYour Environment

    ToAfter useforking the SafeSky API, you'll need tocollection, configure your APIenvironment key:variables:

    1. OpenSelect the Imported CollectionEnvironment:

      Locate
      • In the top-right corner of Postman, click on the environment dropdown
      Select SafeSky UAV API - Sandbox collection(or thatcreate youa imported.new environment)

      SetConfigure AuthorizationEnvironment Variables:

      • Click on the threeeye dotsicon (👁️) next to the collectionenvironment namedropdown, andthen chooseclick Edit.
      • Go toSet the Authorizationfollowing tab.variables:
      • Verify
      that
      the Type isVariable setInitial toValue Current Value APIserver Keyhttps://sandbox-public-api.safesky.app. Enterhttps://sandbox-public-api.safesky.app the following: ss-api-key (leave empty) <your_api_key>
      • KeyImportant: Set x-ss-api-key
      • as a Valuesecret: <your_api_key>type (replacevariable <your_api_key>to withkeep the actualyour API key secure
      The Initial Value will be empty when you received).share the collection, while Current Value contains your personal API key Click Save.

      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 collectionenvironment is importedconfigured:

            Select a Request: Choose any request from the collection (e.g., POST multiple UAV light - return traffic) Review the Request: Check the request body and query parameters Send the authorizationRequest: Click Send 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 up, you can start sending requests to the SafeSky API. Each request in the collectionenvironment Ensure the correct environment is pre-configuredselected within samplethe teststop-right corner Check that server variable points to helphttps://sandbox-public-api.safesky.app youReview getthe startedPostman easily.console for detailed error messages