ScaffoldHub - v2
  • Introduction
  • Modeling
    • Two-way Relationships
  • Setup
    • Backend
    • Frontend
    • File Storage
    • Emails with SendGrid
    • Payments with Stripe
  • Debugging
  • Deployment
    • Database
      • SQL
      • MongoDB
    • Backend
      • Google Cloud - App Engine
      • Google Cloud - Run
      • Under construction...
    • Frontend
      • Firebase Hosting
      • Heroku w/ Subdomains
      • Under construction...
  • Features
    • Projects
    • Preview
    • Tenants
      • Single-Tenant
      • Multi-Tenant
      • Multi-Tenant (w/ subdomains)
    • Payments
    • Security
    • Authentication
      • Sign-in and Sign-up
      • Invitation
      • Password Reset
      • Password Change
      • Email Verification
    • Audit Logs
    • Settings
    • Internationalization (I18n)
    • Entity
      • Form
      • Filter and List
      • Export
      • Import
    • API Documentation
  • Architecture
    • Security
    • File Storage
    • Internationalization (I18n)
    • Payments
    • Typescript Support
    • Rate limiting
    • Technologies Versions
    • Under construction...
  • Recipes
    • Testing the API with Postman
    • Enterprise sign-in with WorkOS
    • Under construction...
  • Support
  • Changelog
    • Documentation
    • Scaffolds
  • Custom Development
  • Legacy Scaffolds
  • Go to ScaffoldHub
Powered by GitBook
On this page
  • Authorization Token
  • Sending an authenticated request
  • Discovering the API endpoints
  • Postman Files

Was this helpful?

  1. Recipes

Testing the API with Postman

PreviousRecipesNextEnterprise sign-in with WorkOS

Last updated 4 years ago

Was this helpful?

Authorization Token

To test the API with Postman you need to first collect the authorization bearer token.

# Method
POST

# URL
http://localhost:8080/api/auth/sign-in

# BODY
{
    "email": "your-email",
    "password": "your-password"
}

Sending an authenticated request

To send an authenticated request you must set the Authorization header to Bearer <token you collected>

On the image, the token is saved on a Postman environment variable.

To set this up, click on the eye icon o the top-right corner.

Then click on Environment > Add.

Then add the token you received on the first step to the current value of the token variable.

Don't forget to select the correct environment on the top-right corner.

Discovering the API endpoints

The easiest way to discover the endpoints of the application is by inspecting the Network tab of the Chrome Developer Tools.

You then copy the Request URL, Request Method, and the Payload.

Postman Files

https://github.com/scaffoldhub/documentation/tree/master/recipes/postman