NAV
bash javascript json ruby

SoTellUs API

Here are the available resources for the API.

Authentication

To authorize, use this code:

require 'SoTellUs'

api = SoTellUs::APIClient.authorize!('apikey')
import SoTellUs

api = SoTellUs.authorize('apikey')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: apikey"

Make sure to replace apikey with your API key.

SoTellUs uses API keys to allow access to the API. You can register a new SoTellUs API key at our developer portal.

SoTellUs expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer <apikey>

Invite

Invitations are useful to invite your customers to review your company. Your customer will recieve a message inviting them to click a link to leave your company a review.

Get list of Invitations

Returns a collection of invites, paginated

Example request:

curl "https://api.sotellus.com/api/v1/invites" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.sotellus.com/api/v1/invites",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": false,
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/invites

HEAD api/v1/invites

Create a new Invitation

Sends a message to your customer, requesting them to follow a link to leave your company a review

Example request:

curl "https://api.sotellus.com/api/v1/invites" \
-H "Accept: application/json" \
    -d "verificationMethod"="mobile" \
    -d "mobile"="autem" \
    -d "email"="lamont.littel@example.org" \
    -d "firstname"="autem" \
    -d "lastname"="autem" \
    -d "referenceId"="autem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.sotellus.com/api/v1/invites",
    "method": "POST",
    "data": {
        "verificationMethod": "mobile",
        "mobile": "autem",
        "email": "lamont.littel@example.org",
        "firstname": "autem",
        "lastname": "autem",
        "referenceId": "autem"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/invites

Parameters

Parameter Type Status Description
verificationMethod string required mobile or email
mobile string optional Required if verificationMethod is mobile
email email optional Required if verificationMethod is email
firstname string required Maximum: 100
lastname string required Maximum: 100
referenceId string optional

Check if phone is valid

And if it is available to create an Invite

Example request:

curl "https://api.sotellus.com/api/v1/invites/checkPhone" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.sotellus.com/api/v1/invites/checkPhone",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/invites/checkPhone

Review

Reviews are the heart of the SoTellUs API. This api gives you some access to manage your reviews. Note you are not allowed to programatically create reviews, as they are only allowed to be created by your customers.

Get list of Reviews

Returns a collection of reviews, paginated

Example request:

curl "https://api.sotellus.com/api/v1/reviews" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.sotellus.com/api/v1/reviews",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "total": 988,
    "per_page": 15,
    "current_page": 1,
    "last_page": 66,
    "next_page_url": "https:\/\/api.sotellus.com\/api\/v1\/reviews?page=2",
    "prev_page_url": null,
    "from": 1,
    "to": 15,
    "data": [
        {
            "uniqueid": "41ykuet2",
            "status": 1,
            "type": "video",
            "display_name": "Troy H",
            "firstname": "Troy",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/27557-ea3128505887.image.thumb.jpg",
            "date_added": 1439583314,
            "user_added": 0,
            "date_updated": 1474914386,
            "user_updated": 0
        },
        {
            "uniqueid": "kc1d64wq",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/27745-bd3f53d42e81.image.thumb.jpg",
            "date_added": 1442350506,
            "user_added": 0,
            "date_updated": 1474915572,
            "user_updated": 0
        },
        {
            "uniqueid": "9vv8tx98",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/27746-adeacdd9c7b6.image.thumb.jpg",
            "date_added": 1442350627,
            "user_added": 0,
            "date_updated": 1474915580,
            "user_updated": 0
        },
        {
            "uniqueid": "8xhxdq2u",
            "status": 2,
            "type": "video",
            "display_name": "Rich J",
            "firstname": "Rich",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/27749-96ed8752b031.image.thumb.jpg",
            "date_added": 1442361308,
            "user_added": 0,
            "date_updated": 1474915584,
            "user_updated": 0
        },
        {
            "uniqueid": "uxcebydr",
            "status": 2,
            "type": "video",
            "display_name": "Troy H",
            "firstname": "Troy",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28236-1ed27e84bb51.jpg",
            "date_added": 1446677093,
            "user_added": 0,
            "date_updated": 1474905235,
            "user_updated": 0
        },
        {
            "uniqueid": "39137f2h",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28606-3d4ef351dec0.jpg",
            "date_added": 1451426469,
            "user_added": 0,
            "date_updated": 1474905551,
            "user_updated": 0
        },
        {
            "uniqueid": "yt7xgn51",
            "status": 2,
            "type": "video",
            "display_name": "T H",
            "firstname": "T",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28607-28ab4384c412.jpg",
            "date_added": 1451426605,
            "user_added": 0,
            "date_updated": 1474905557,
            "user_updated": 0
        },
        {
            "uniqueid": "gddf2tep",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28613-53c228cb78a1.jpg",
            "date_added": 1451428298,
            "user_added": 0,
            "date_updated": 1474905575,
            "user_updated": 0
        },
        {
            "uniqueid": "cq8eattq",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28614-02648a361a33.jpg",
            "date_added": 1451429077,
            "user_added": 0,
            "date_updated": 1474905582,
            "user_updated": 0
        },
        {
            "uniqueid": "eaq3hqcd",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28615-58546c7dd7c1.jpg",
            "date_added": 1451430207,
            "user_added": 0,
            "date_updated": 1474905587,
            "user_updated": 0
        },
        {
            "uniqueid": "v",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28616-c499ac416547.jpg",
            "date_added": 1451430494,
            "user_added": 0,
            "date_updated": 1474905592,
            "user_updated": 0
        },
        {
            "uniqueid": "j54r40uc",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28719-a6c1f4f8d229.image.thumb.jpg",
            "date_added": 1453172083,
            "user_added": 0,
            "date_updated": 1474922552,
            "user_updated": 0
        },
        {
            "uniqueid": "d0kgpv48",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28720-9d43979a6f5f.image.thumb.jpg",
            "date_added": 1453172814,
            "user_added": 0,
            "date_updated": 1474922572,
            "user_updated": 0
        },
        {
            "uniqueid": "nfcq6307",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28721-6781abfaa7c9.image.thumb.jpg",
            "date_added": 1453173957,
            "user_added": 0,
            "date_updated": 1474922587,
            "user_updated": 0
        },
        {
            "uniqueid": "uy98uwgv",
            "status": 2,
            "type": "video",
            "display_name": "Trevor H",
            "firstname": "Trevor",
            "review": null,
            "review_highlight": null,
            "stars": 10,
            "thumbnail_url": "https:\/\/2dcd0288bb5ad00b85d9-fabf710445f1981e114ecad46bc90741.ssl.cf1.rackcdn.com\/28723-6dfefee9138f.image.thumb.jpg",
            "date_added": 1453174858,
            "user_added": 0,
            "date_updated": 1474922589,
            "user_updated": 0
        }
    ]
}

HTTP Request

GET api/v1/reviews

HEAD api/v1/reviews

Get Review

Returns a review

Example request:

curl "https://api.sotellus.com/api/v1/reviews/{uniqueid}" \
-H "Accept: application/json" \
    -d "uniqueid"="voluptas" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.sotellus.com/api/v1/reviews/{uniqueid}",
    "method": "GET",
    "data": {
        "uniqueid": "voluptas"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": false,
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/reviews/{uniqueid}

HEAD api/v1/reviews/{uniqueid}

Parameters

Parameter Type Status Description
uniqueid string required Maximum: 9
bash javascript json ruby