Reditus Documentation

Reditus • getreditus
Help

Apiary Powered Documentation

Sign in with Apiary account.

Reditus Documentation

Introduction

This is the public API documentation for Reditus.

All our API calls use JSON format.

Allowed HTTPs requests

PUT     : To create resource 
POST    : Update resource
GET     : Get a resource or list of resources
DELETE  : To delete resource

Server Responses

  • 200 OK - the request was successful (some API calls may return 201 instead).

  • 201 Created - the request was successful and a resource was created.

  • 204 No Content - the request was successful but there is no representation to return (i.e. the response is empty).

  • 400 Bad Request - the request could not be understood or was missing required parameters.

  • 401 Unauthorized - authentication failed or user doesn't have permissions for requested operation.

  • 403 Forbidden - access denied.

  • 404 Not Found - resource was not found.

  • 405 Method Not Allowed - requested method is not supported for resource.

Reference

Partners API

Partners Collection

List Partners

Retrieve paginated list of partners.

URI Parameters
name_eqFilter by name
email_eqFilter by email
paypal_email_eqFilter by PayPal email
pagePage number
per_page

Records to be displayed per page (max 50)

Partner

Get Partner

Show data for a partner.

URI Parameters
idPartner id

Partnerships API

Partnerships Collection

List Partnerships

Retrieve paginated list of partnerships.

URI Parameters
state_eq

Filter by state (pending, accepted, declined)

created_at_lt

Created before (e.g. "2022-12-24%2012:47:45%20+0200")

created_at_gt

Created after (e.g. "2021-11-23%2012:47:45%20+0200")

pagePage number
per_page

Records to be displayed per page (max 50)

Partnership

Get Partnership

Show data for a partnership.

URI Parameters
idPartnership id

Payments API

Track Payments

Referral Payment

The payments API allows you to add payments for your referrals. If you want to track a one-off payment, just don't specify subscription_id, interval and interval_count.

Request
object
  • referral_id (string) - Reditus id of the referral (required if referral_email not set)
    string
  • referral_email (string) - Email of the referral (required if referral_id not set)
    string
  • idempotency_key
    A unique string to identify this payment. Used to prevent double payments.
    string, required
  • amount

    Payment amount (in cents)

    number, required
  • currency
    Payment currency
    string, required
  • interval

    Subscription interval ("month"/"year")

    string
  • interval_count

    Number of intervals the payment is made (default: 1)

    number
  • subscription_id string
    Should be the id of the subscription on your side. Used to associate subsequent payments to this subscription.
    string

Payment

Get Payment

Show data for a payment.

URI Parameters
idPayment id

Referrals API

Referrals Collection

List Referrals

Retrieve paginated list of referrals.

URI Parameters
state_eqFilter by state
email_eqFilter by email
created_at_lt

Created before (e.g. "2022-12-24%2012:47:45%20+0200")

created_at_gt

Created after (e.g. "2021-11-23%2012:47:45%20+0200")

state_set_at_lt

State set at before (e.g. "2022-12-24%2012:47:45%20+0200")

state_set_at_gt

State set at before (e.g. "2021-12-24%2012:47:45%20+0200")

pagePage number
per_page

Records to be displayed per page (max 50)

Referral

Get Referral

Show data for a referral.

URI Parameters
idReferral id

Subscriptions API

The subscriptions API allows you manage referral subscriptions.

Subscription

Get Subscription

Show data for a subscription

URI Parameters
idReditus id path variable

Cancel Subscription

Cancels a subscription

URI Parameters
idReditus id path variable

Tracking API V2

To be used alongside the V2 Tracking script

Track Conversions

Referral Conversion

The tracking API allows you to track conversions for any partner.

Request
object
  • email
    Email of the referral
    string, required
  • affiliate_slug

    URL parameter of the affiliate (i.e. https://company.com?red=john -> john)

    string, required
  • uid

    Internal ID of the user/customer

    string, optional
  • gr_id

    Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.

    string, optional
Request
object
  • email
    Email of the referral
    string, required
  • affiliate_slug

    URL parameter of the affiliate (i.e. https://company.com?red=john -> john)

    string, required
  • uid

    Internal ID of the user/customer

    string, optional
  • gr_id

    Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.

    string, optional
Request
object
  • email
    Email of the referral
    string, required
  • affiliate_slug

    URL parameter of the affiliate (i.e. https://company.com?red=john -> john)

    string, required
  • uid

    Internal ID of the user/customer

    string, optional
  • gr_id

    Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.

    string, optional

Tracking API V1 - DEPRECATED

Track Conversions

Referral Conversion

The tracking API allows you to track conversions for any partner.

Request
object
  • email
    Email of the referral
    string, required
  • gr_id

    Cookie set by the tracking script in the referral's browser

    string, required
  • pk

    Can replace gr_id, in combination with uid being used to mark the correct affiliate as the referee

    string, optional
  • uid

    Can replace gr_id, in combination with pk, being used to mark the correct affiliate as the referee

    string, optional