Documentation Index

Fetch the complete documentation index at: https://help.hyperscience.ai/llms.txt

Use this file to discover all available pages before exploring further.

Using Postman with OAuth and Machine Credentials

Prev Next

This article explains how to create and utilize OAuth 2.0 Machine Credentials from Hypercell to access the API using Postman.

Postman is a popular API development platform that helps developers test, build, and modify APIs. It allows users to create and send HTTP requests to web services and examine the responses.

  1. In your Hyperscience instance, create machine credentials by going to Users > Machine Credentials and following the steps in Managing Machine Credentials.

  2. In Postman, create an HTTP request for an API endpoint.

  3. Under Authorization, select OAuth 2.0.

  4. In the Configure New Token section, change Grant Type to Client Credentials.

  5. Paste the Client ID and Client Secret from your Hyperscience instance into their respective fields in the Configure New Token section.

  6. In the Access Token URL field, enter the URL of your Hypercell instance followed by /api/v5/local_identity_provider/oauth2/token (e.g., https://example.com/api/v5/local_identity_provider/oauth2/token).

  7. (SaaS deployments only) Under Headers, add a header named HyperscienceLocalIdentityProvider with a value of 1.

  8. Click Get New Access Token.

  9. In the Manage Access Tokens dialog box, click Use Token.

    Note that a temporary access token (eyJhbG…) has been populated in the Current Token section of the Postman HTTP request.

  10. Click Send in the upper-right hand corner.

    You should see a successful (200 OK) HTTP response in Postman.