Getting Started

REST APIs

APIs works like a messenger or mediator that transfers the data to the server when users act on the site. You can request a call on these APIs to share the data with the provider and respond in return.

InviteReferrals provide the endpoints along with some specifications which perform these actions that indicate returns of the data. With the help of this data, you can easily track the actions performed by the users along with data associated.

INVITEREFERRALS API ENDPOINT

You can obtain all the resources accessible via API over the HTTPS server. Whenever an API calls to obtain data from a web application or server, an acknowledgment has always been sent back.

ACCESS DATA VIA API

You can send and obtain the data by hitting on the below API Endpoints.

• You can call the below Endpoint for collecting and sending data regarding the Conversions.
  https://www.ref-r.com/api/v1

API RATE LIMIT

• The API rate limit is the number of API calls an app or a user can make within a given period.
• You can make up to 500 API requests per minute on an API.
• If the API rate limit passes, the app will stop performing. All API requests are subject to rate limits.

👍

CONTACT SUPPORT

If you want to exceed the API limit, feel free to contact us at [email protected].

HOW TO SEND THE DATA

You can send the data in JSON format.
You can send the data bypassing the Format parameter in the URL as JSON.
You can pass any parameters as HTTP query string parameters in the API URLs.

WHAT IS THE DATE FORMAT

The timestamps for the data will be in the following format :

📘

yyyy-MM-ddTHH:mm:ss

2013-01-26T07:31+0000

HOW TO RECEIVE THE API RESPONSE

You will receive an API response in the following format or container: i.e. response.

This API response has the following properties:

Status: It will either be presented as a failure as success will depend upon the response of the server.

Data: It will comprise the data for the requested resource

Message: The said property will define the reason for the corresponding status.

{
    "response" : {
        "data" : {
            ...
        },
        "message" : "success",
        "status" : "success"
    }
}

ACCESS THE INVITEREFERRALS API

Login to the InviteReferrals account.

Navigate to Profile > INTEGRATION

curl --request POST \
  --url https://www.ref-r.com/api/v1/conversion/add \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-brand-id: YOUR_BRAND_ID' \
  --data '{"order_id":"3455","campaign_id":3247,"referee_name":"Tarun","referee_email":"[email protected]"}'

📘

Note:

• Replace YOUR_API_KEY with InviteReferrals' Secret key.
• Replace YOUR_BRAND_ID with InviteReferrals' Brand id.

ERRORS

Errors will be displayed using the standard HTTP error code syntax. Find the following description for the error codes.