Friendbuy First-Gen Platform

This documentation for the Friendbuy First-Gen Platform integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Friendbuy First-Gen Platform, visit our connection instructions.

Version

This integration utilizes the Friendbuy First-Gen Platform REST API v2.

Base URL

The base URL used for all Friendbuy First-Gen Platform API endpoints:

https://api.friendbuy.com/v2

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
POST	/tokens/merchant	Obtain and refresh access token

---

Authentication & Authorization

The DataGrail Friendbuy First-Gen Platform integration connects using token authentication which requires an Access Key and Secret Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Friendbuy First-Gen Platform API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

---

Limits

Limits in Friendbuy First-Gen Platform are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Friendbuy First-Gen Platform integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search shares using configured identifiers.
2. Search conversions using configured identifiers.
3. Search clicks using configured identifiers.
4. Retrieve customer details using configured identifiers.
5. Search purchases using detected customer IDs.
6. Search personal referral links using configured identifiers.
7. Search email captures using configured identifiers.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/clicks	Search clicks
GET	/conversions	Search conversions
GET	/customers/id	Retrieve a customer details
GET	/email_captures	Retrieve a list of email captures
GET	/personal_referral_links	Retrieve a list of personal referral links
GET	/purchases	Retrieve a list of purchases
GET	/shares	Search shares

---

Deletion

DataGrail's Friendbuy First-Gen Platform integration provides Synchronous (Whole Record) Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Delete the data stored for a user using configured identifiers.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/user_data/delete	Delete the data stored for a user

---