Astra

API Overview

Estimated reading: 3 minutes 0 views

In this tutorial you will discover how to get the most out of FastCredit Pro’s API capabilities. This guide will walk you through the API details, creating application passwords, and utilizing Google Sheets for basic integration. The focus will be on the three main API endpoints available: Get User Credits, Update User Credits, and Update Total User Credits. Let’s get started!

Part 1: Understanding FastCredit Pro API Endpoints

Before diving into the technicalities, it’s crucial to know what each API endpoint does:

  • Get User Credits: Retrieves the existing credits for a user.
  • Update User Credits: Adds credits to a user’s existing balance.
  • Update Total User Credits: Resets a user’s credit balance to a specified amount.

Steps:

  1. Navigate to the API Details Section: Open FastCredit Pro and go to the ‘Integrations and API’ tab. Look for the section called ‘API Details’.
  2. Review the Available Endpoints: Three API endpoints should be visible: Get User Credits, Update User Credits, and Update Total User Credits.
  3. Keep an Eye on Future Updates: As of now, these are the only three endpoints, but FastCredit Pro may add more in the future.

Part 2: Setting up Application Passwords for API Access

Now, let’s create an application password to secure your API requests.

Steps:

  1. Go to User Profile: Open your admin user profile in FastCredit Pro.
  2. Locate Application Passwords Section: Scroll down until you see the section that says ‘Application Passwords’.
  3. Create a New Application: Click to create a new application and give it a name, such as ‘Credits App Demo’.
  4. Copy the Generated Password: After creating, a unique password will be generated. Copy this password along with your username. These will serve as your API credentials.

Part 3: Google Sheets Integration – Basic Example

We will briefly look into how to integrate Google Sheets with the FastCredit Pro API.

Steps:

  1. Set up a Google Sheet: Create a Google Sheet and add an Apps Script to it.
  2. Enter API Credentials: In the script, enter the username and application-specific password you generated earlier.
  3. Add API Endpoints: In the script, add the API endpoints for Get User Credits, Update User Credits, and Update Total User Credits.
  4. Run the Script: Use the custom menu in Google Sheets to run the script. It should populate the sheet with user IDs, emails, and existing credit balances.
  5. Update Credits: To update or reset the credits, modify the values in the Google Sheet and run the appropriate script.

Part 4: Confirmation & Verification

After running scripts to update user credits, you may see a status like ‘Confirmation Required’.

Steps:

  1. Check FastCredit Pro: If this status appears, head back to FastCredit Pro and refresh the user page to see if the credits have been updated.
  2. Verify in Google Sheets: You can also run the ‘Get User Credits’ script again in Google Sheets to verify that the balances have been updated.

Conclusion

So there you have it! You now know how to harness the API functionalities of FastCredit Pro to manage user credits effectively. While the API might appear simple with its three endpoints, it’s incredibly powerful when combined with external tools like Google Sheets. If you have more questions or need further clarification, don’t hesitate to reach out. We’re here to assist you every step of the way.

Leave a Reply

Your email address will not be published. Required fields are marked *

Share this Doc
CONTENTS
Scroll to Top