API Version 1.1

This documentation explain how to register, configure, and develop your app so you can successfully use our APIs

Create Marketing App

To create your marketing app and begin using the marketing API, you must first register with App Dashboard. Registration creates a custom application in our system with a custom reward type and security key (API key) to use for our API access.

  1. You will need to create a new Marketing App Create New Marketing App
  2. Once you created your Marketing App you will get your API KEY and ability to see the docs.

Create App

In order for your app to access our APIs, you must register your app using the App Dashboard. Registration creates an App ID that lets us know who you are, helps us distinguish your app from other apps.

  1. You will need to create a new App Create New App
  2. Once you created your App you will get your app_id and app_secret

After creating your Developer App

Log in With

Log in With system is a fast and convenient way for people to create accounts and log into your app. Our Log in With system enables two scenarios, authentication and asking for permissions to access people's data. You can use Login With system simply for authentication or for both authentication and data access.

  1. Starting the OAuth login process, You need to use a link for your app like this:
    <a href="">Log in With SoMee Social</a>

    Note also that you can pass a STATE URL parameter with your login url, and we'll pass that STATE parameter back to your server with that same code.

    So, for example, let's say that you need to support login to your app with SoMee - but you need to know what specific PART of your app it's coming from, and you have some ID that you need to handle.

    To do that, you would ENCRYPT/ENCODE (you should use an IV/KEY stored on your server, so only your system can decode the string) the state, and send the state with the login string:

    <a href="">Log in With SoMee Social</a>

    The user will be redirect to Log in With page like this

    login pic
  2. Once the user accpeted your app, the user will be redirected to your App Redirect URL with auth_key like this:

    --OR if you passed a state parameter--
    This auth_key valid only for one time usage, so once you used it you will not be able to use it again and generate new code you will need to redirect the user to the log in with link again.

    For security reasons, we are NOT storing the 'state' anywhere - meaning whatever you send us, gets sent back. So, you should get into the habit of confirming the state on YOUR end when before actually doing anything with the state data

Access Token

Once you get the user approval of your app Log in With window and returned with the auth_key which means that now you are ready to retrive data from our APIs and to start this process you will need to authorize your app and get the access_token and you can follow our steps to learn how to get it.

  1. To get an access token, make an HTTP GET request to the following endpoint like this:
        $app_id = "YOUR_APP_ID"; // your app id
        $app_secret = "YOUR_APP_SECRET"; // your app secret
        $auth_key = $_GET['auth_key']; // the returned auth key from previous step
        $get = file_get_contents("$app_id&app_secret=$app_secret&auth_key=$auth_key");
        $json = json_decode($get, true);
        if(!empty($json['access_token'])) {
            $access_token = $json['access_token']; // your access token
    This access_token valid only for only one 1 hour, so once it got invalid you will need to genarte new one by redirect the user to the log in with link again.
Developer App APIs

Once you get your access_token you can then begin to interact with the main SoMee Developer API

Click View Docs to view the API documentation (we keep this updated all the time).

SoMee Social