Kindred Public API Guide
Introduction
The Kindred external APIs allow partners to access all the relevant information regarding
their users’ converted transactions including commissions, donations, and brands, as well as users
balances and access to the Kindred charity database to allow users to select their own charities as
they want. Additionally, the APIs give access to the Kindred deals that users are activating, even if
they don’t go ahead and purchase, giving insights into user behaviour and the impact of a partners’
in-app advertising.
The APIs are accessed via a RESTful endpoint through HTTPS.
The data can be used to power a partners’ engagement and marketing efforts, providing data to
notify users of their savings, their donations and more, helping to drive retention and keep users on
their app.
Authentication
To access our API, you will need to get authenticated. We will provide you with your client
credentials in order to access the APIs.
The authentication mechanism used is Oauth2 client credentials flow.
POST https://api-partners.kindred.co/auth/connect/token
CONTENT-TYPE application/x-www-form-urlencoded
client_id=[YOUR_CLIENT_ID]&
client_secret=[YOUR_CLIENT_SECRET]&
grant_type=client_credentials&
scope=partners-public
Note: The auth token expires after 1 hour.
Available APIs
We provide an online documentation that specify all of the available endpoints and a sandbox tool
to allow you to try them out within the browser through Swagger.
The online documentation can be found at: https://api-partners.kindred.co/partners/public/docs/index.html
There are 7 core APIs available as detailed below.
API Rate Limits: 400 requests per minute
Users
Used to access a user’s current charity settings, their current balance and total aggregate balance.
Conversions
Used to access a user’s conversions, the commission earned, donations earned and any partner
commission earned for each conversion. Additional information about the brand and the GMV is
also available
GetPublisherConversions
Get a list of conversions based on a list of SubIds. Results are in descending order.
Charities
Used to access the full list of Charities that are available for selection by users, to be parsed to the
Kindred Keyboard SDK for donation allocation for conversions.
Clicks
Used to access simple deal activation data for a user.
Merchants
Search:
This endpoint allows you to search using a “term”. This can be what the user is typing in real-time and we return the relevant deals for you in a paginated result.
There is an optional parameter for country which we recommend using as this will bring back the applicable deals for the users' country that they are currently based in.
Lookup:
This endpoint allows you to search for a deal using a particular domain. For example, if you wanted to find out if there is a deal for nike.com, you will call this endpoint. This will return a single deal if there is a deal available.
List
Get a list of all merchant deals by country code. The endpoint requires a CountryCode to be passed through to get the best deal available for each country. The value should be a valid administrative language alpha-2 code. e.g., ‘UK’ or ‘US’ or ‘FR’.
Activating a deal:
There are two ways to activate deals. If you want to activate deals without consideration for a user, you can use the Sub ID incentive endpoint. If you want to track the deal and have it associated with the user, you can use the User incentive endpoint.
Sub ID incentive deal activation
You can get your unique tracking link for any of the deals by calling the following endpoint:
Once this endpoint is hit, the deal is activated by Kindred and the user will be redirected to the merchant website with tracking included.
User incentive deal activation
You can get your unique tracking link for any of the deals by calling the following endpoint:
Once this endpoint is hit, the deal is activated by Kindred and the user will be redirected to the merchant website with tracking included.
Note, if you are using one of our SDKs, the partnerUserId must be the same as the ID you set as part of the SDK configuration.
Contact the SDK support team to get access to your partner ID.
The dealId is returned as part of the results of the Search/Lookup endpoints. The subId is an optional parameter that you can pass through if you wish to match up any of the clicks from your side to a particular conversion.
For any questions or support with your integration, or to receive your API details, please email
[email protected].
License Agreement: https://event.kindred.co/licensing-terms-and-conditions
Updated over 1 year ago