1️Authentication APIs (3)

The authentication apis are prerequisite to use address book api and other apis

Step 1: Get Session API

GET https://api.socialinviter.com/api/v2/session

This API will provide the session key and the list of all available services for the APP. This session key should be used in all the other API calls.

Note: The session key is valid for 24 hours

Query Parameters

Name	Type	Description
license*	string	The license which you can get from your SocialInviter account.

200

{
  "data": {
    "session": "5ccb85414453180155beb049",
    "authUrl": "https://yourdomain.com/oauth.html",
    "services": [
      {
        "id": "google"
      },
      {
        "id": "yahoo"
      },
      {
        "id": "outlook"
      }
    ]
  },
  "status": {
    "type": "success",
    "message": ""
  }
}

400

{
  "data": {},
  "status": {
    "type": "error",
    "key": "missing_input",
    "message": "Missing App key"
  }
}

401

{
  "data": {},
  "status": {
    "type": "error",
    "key": "Invalid_License_key",
    "message": "Invalid License Key"
  }
}

Step 2: Get Authentication URL API

Note: For apple service, please directly call get token API.

GET https://api.socialinviter.com/api/v2/auth

This API allows you to get the authentication URL, then redirect the user to this auth URL for authentication.

Query Parameters

Name	Type	Description
service*	string	name of the service you want to authenticate, eg: google, yahoo, outlook etc. See the full supported list of services under Supported Services
redirecturl	string	(MOSTLY NEEDED IF YOU ARE NOT USING oauth.html) if you want to override the redirect URL provided in your license settings, pass this parameter
product*	string	name of the product, eg: contactimporter, socialpost ,socialconnect

Headers

Name	Type	Description
session*	string	Session which you received from session API

200

{
  "data": {
    "authurl": "<Authentication url will be here>",
    "service": "google"
  },
  "status": {
    "type": "success",
    "message": ""
  }
}

400

{
  "data": {},
  "status": {
    "type": "error",
    "key": "invalid_service",
    "message": "Invalid service"
  }
}

401: Unauthorized REST API access is not available for Basic plan

{
  "data": {},
  "status": {
    "type": "error",
    "key": "access_denied",
    "message": "The current plan does not have access to REST APIs"
  }
}

Step 3: Get Token API

The below video shows how to get the "code" after authenticating your user.

3.1 > Get Token API (For all services other than APPLE)

POST https://api.socialinviter.com/api/v2/accesstoken

Get access token that will be used to fetch the address book.

Headers

Name	Type	Description
session*	string	Session which you received from session API
content-type*	string	Value should be as belowapplication/x-www-form-urlencoded

Request Body

Name	Type	Description
service*	string	name of the service, eg: google, yahoo, outlook etc. See the full supported list of services under Supported Services section
code*	string	Code value which you received in QueryString on oauth.html page after authentication redirection ℹ️ For Twitter , pass code as oauth_token:oauth_verifier format(token and verifier are received in querystrings of oauth.html). The example format should be -> abc:123
product*	string	name of the product, eg: contactimporter, socialpost ,socialconnect

200

{
  "data": {
    "service": "google",
    "token": "xxxxxxxxxxxxxxxxxxxxxxx",
    "userid": "xxxxxxxxxx"
  },
  "status": {
    "message": "",
    "type": "success"
  }
}

400

{
  "data": {},
  "status": {
    "type": "error",
    "key": "access_token_fetch_error",
    "message": "error fetching access token"
  }
}

3.2 > Get Token API (Only for APPLE service)

POST https://api.socialinviter.com/api/v2/accesstoken

Get access token that will be used to fetch the address book.

Headers

Name	Type	Description
session*	string	session which you received from session API
content-type*	string	Value should be as below application/x-www-form-urlencoded

Request Body

Name	Type	Description
service*	string	name of the service, eg: apple
email*	string	Email id of the user
password*	string	App-specific password or password
product*	string	name of the product, eg: contactimporter, socialpost ,socialconnect

200

{
  "data": {
    "service": "apple",
    "token": "xxxxxxxxxxxxxxxxxxxxxxx",
    "userid": "xxxxxxxxxx"
  },
  "status": {
    "message": "",
    "type": "success"
  }
}

400: Bad Request

{
  "data": {},
  "status": {
    "type": "error",
    "key": "access_token_fetch_error",
    "message": "error fetching access token"
  }
}

2️pageAddress Book API

pageSupported Services

pageError Handling