Skip to content
The Releans Python SDK allow you to get up an running with Releans API quickly in your project. # What you can do with Releans Services? 1- Send emails 2- On-time SMS 3- Automation for reminders and appointments
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
releansapi
tests
LICENSE
MANIFEST.in
README.md
requirements.txt
setup.py
test-requirements.txt
tox.ini

README.md

Getting started

The Releans SDK enables developers to use Releans Services in their code. You can get started in minutes.

How to Build

You must have Python 2 >=2.7.9 or Python 3 >=3.4 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

  • Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
  • Run the command pip install -r requirements.txt. This should install all the required dependencies.

Building SDK - Step 1

How to Use

The following section explains how to use the Releansapi SDK package in a new project.

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1

Name the directory as "test"

Add a new project in PyCharm - Step 2

Add a python file to this project with the name "testsdk"

Add a new project in PyCharm - Step 3

Name it "testsdk"

Add a new project in PyCharm - Step 4

In your python file you will be required to import the generated python library using the following code lines

from releansapi.releansapi_client import ReleansapiClient

Add a new project in PyCharm - Step 4

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

Run Test Project - Step 1

How to Test

You can test the generated SDK and the server with automatically generated test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke pip install -r test-requirements.txt
  3. Invoke nosetests

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter Description
o_auth_access_token OAuth 2.0 Access Token

API client can be initialized as following.

# Configuration parameters and credentials
o_auth_access_token = 'o_auth_access_token' # OAuth 2.0 Access Token

client = ReleansapiClient(o_auth_access_token)

Class Reference

List of Controllers

Class: MessageController

Get controller instance

An instance of the MessageController class can be accessed from the API Client.

 message_controller = client.message

Method: get_all_messages

List all messages sent by the account.

def get_all_messages(self,
                         accept)

Parameters

Parameter Tags Description
accept Required TODO: Add a parameter description

Example Usage

accept = '*/*'

result = message_controller.get_all_messages(accept)

Method: get_view_message

Return the details of the message.

def get_view_message(self,
                         id,
                         accept)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description
accept Required TODO: Add a parameter description

Example Usage

id = 'id'
accept = '*/*'

result = message_controller.get_view_message(id, accept)

Method: create_send_sms_message

Send a single message.

def create_send_sms_message(self,
                                accept,
                                sender_id,
                                mobile_number,
                                message)

Parameters

Parameter Tags Description
accept Required TODO: Add a parameter description
senderId Required Sender id to send the message from.
mobileNumber Required The mobile number supposed to receive the message.
message Required Message text.

Example Usage

accept = 'Accept'
sender_id = 'senderId'
mobile_number = 'mobileNumber'
message = 'message'

result = message_controller.create_send_sms_message(accept, sender_id, mobile_number, message)

Back to List of Controllers

Class: SenderController

Get controller instance

An instance of the SenderController class can be accessed from the API Client.

 sender_controller = client.sender

Method: get_sender_name_details

Return the details of the sender name.

def get_sender_name_details(self,
                                id,
                                accept)

Parameters

Parameter Tags Description
id Required TODO: Add a parameter description
accept Required TODO: Add a parameter description

Example Usage

id = 'sender-id'
accept = '*/*'

result = sender_controller.get_sender_name_details(id, accept)

Method: create_sender_name

Create a new sender id to send messages using it

def create_sender_name(self,
                           accept,
                           content_type,
                           body)

Parameters

Parameter Tags Description
accept Required TODO: Add a parameter description
contentType Required TODO: Add a parameter description
body Required TODO: Add a parameter description

Example Usage

accept = 'text/plain'
content_type = 'text/plain'
body = 'Your sender name'

result = sender_controller.create_sender_name(accept, content_type, body)

Method: get_all_senders

List all senders names associated with the account

def get_all_senders(self,
                        accept)

Parameters

Parameter Tags Description
accept Required TODO: Add a parameter description

Example Usage

accept = '*/*'

result = sender_controller.get_all_senders(accept)

Back to List of Controllers

Class: BalanceController

Get controller instance

An instance of the BalanceController class can be accessed from the API Client.

 balance_controller = client.balance

Method: get_balance

Get your available balance

def get_balance(self,
                    accept)

Parameters

Parameter Tags Description
accept Required TODO: Add a parameter description

Example Usage

accept = 'text/plain'

result = balance_controller.get_balance(accept)

Back to List of Controllers

You can’t perform that action at this time.