Overview

Responsive supports OAuth for authentication.

Creating OAuth credentials

1. Go to Company Features > OAuth Client.

2. Click Add OAuth Clients and enter a name, description, and domain.

   • The Domain field accepts fully qualified domain names only. Domains with protocol or that contain paths or query parameters, IP addresses, wildcards, ports, or trailing slashes will be declined.

     • Approved examples: 

       • www.google.com

       • api.company.co.uk

       • app.my-org.internal

     • Declined examples: 

       • https://google.com

       • google.com/callback

       • google.com/

   • The Domain field supports a maximum length of 253 characters; each domain label (text between dots) supports a maximum length of 63 characters.

3. Click Save. Your Client ID, Client Secret, and URL is generated.
   Note: Copy and save your credentials; the Client Secret won’t be shown again after you leave the page.
   

4. The name, description, domain, and created date appear on the list of OAuth clients. You can manage the information by:
   

   • Hovering over the three-dot menu and selecting Edit to regenerate the Client Secret.

   • Hovering over the three-dot menu and selecting Delete to delete the credentials.

Making API requests via OAuth using an access token

You can make API requests via OAuth using an access token that can be generated from your Client ID and Client Secret.
Note: Contact our Support team if you need your Client ID and Secret details.

Generating access tokens

1. Use your company’s designated URL (example: https://sb01-us-west-2.rfpio.com/rfpserver/api/oauth/token).
   

2. Under the request Body, click the x-www-form-urlencoded radio button.

3. Pass the Key and Values for client_id, client_secret and grant_type.

4. Send the request. The access token is generated and visible in the response body.

Accessing APIs

1. Pass the Request URL: https://<your-subdomain>.rfpio.com

   • Responsive APIs use the HTTP GET and POST methods and require a JSON request body.

   • Responsive's API calls return HTTP status codes. Some API calls also return JSON response bodies that include information about the resource.

   • You can pass the user API endpoints and choose the method as GET and POST for the respective endpoints shared in the postman collections.
     Example:
     

2. Once the endpoint is configured, go to Authorization and select OAuth 2.0 from the Auth Type drop-down list.
   

3. Select Client Credentials from the Grant type drop-down list and enter https://<your-subdomain>.rfpio.com/rfpserver/api/oauth/token in the Access Token URL field for all the API endpoints.
   

4. Enter the given Client ID and Client Secret in their respective fields, then generate the access token you'll use to get responses from the respective user APIs.