Secure Your API Endpoint

As you build, ship, and deploy workflows on BuildShip, it's crucial to ensure the security of your API endpoint when making it accessible on the internet.

Secure-workflow

Using Authorization Header

The Authorization header provides the server with information to authenticate and authorize the client making a request. It typically contains a token or credentials that the server uses to validate the client’s identity and grant or deny access to the requested resource.

Accessing Authorization Header

To secure your API endpoint, you can utilize the REST API Authorization Header to validates the API key. It enables to authenticate and authorize users, protecting the API from unauthorized access. Follow these simple steps:

  • Click on the Edit icon (✎) on the REST API Trigger.
  • Add a new input under Request Headers - authorization.
  • Click on Save.
authorizarion-header

Adding Condition to Validate Header

To enhance security, use a Branch Node to add a condition that validates and verifies the authorization header in the API request:

  • Set the condition in the Branch Node as Authorization Header Value == key-to-match. Utilize variables for flexibility (refer to the image below).
  • Organize your workflow nodes into the "then" and "else" conditions accordingly.
authorizarion-header-condition

Congratulations! Your API Endpoint is Now Secured

With the implemented security measures, you can confidently test and ship your workflow, ensuring the endpoint's safe usage within your application. Your workflow structure should resemble the following after following the above steps:

authorizarion-header-condition-workflow

Additional Resources for Database Integration

For Supabase Database

If you're using Supabase as your database, refer to this video tutorial that demonstrates building a complete secure Supabase application from scratch.

For Firebase Database

If you're using Firebase as your database, check out our dedicated Firebase Authenticated User Trigger documentation for seamless integration here.

Need Help?

  • 💬
    Join BuildShip Community

    An active and large community of no-code / low-code builders. Ask questions, share feedback, showcase your project and connect with other BuildShip enthusiasts.

  • 🙋
    Hire a BuildShip Expert

    Need personalized help to build your product fast? Browse and hire from a range of independent freelancers, agencies and builders - all well versed with BuildShip.

  • 🛟
    Send a Support Request

    Got a specific question on your workflows / project or want to report a bug? Send a us a request using the "Support" button directly from your BuildShip Dashboard.

  • ⭐️
    Feature Request

    Something missing in BuildShip for you? Share on the #FeatureRequest channel on Discord. Also browse and cast your votes on other feature requests.