CynSMS-Python-Package 1.0

This Api is meant for 3rd party integrations

Getting started

This Api is meant for 3rd party integrations

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.

How to Use

The following section explains how to use the CynSmsPythonPackage 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.

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

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

2. Add a new Test Project

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

Name the directory as "test"

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

Name it "testsdk"

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

from cyn_sms_python_package.cyn_sms_python_package_client import CynSmsPythonPackageClient

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

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

API client can be initialized as following.

client = CynSmsPythonPackageClient()

Class Reference

List of Controllers

• APIController

APIController

Get controller instance

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

 client_controller = client.client

create_send_sms

TODO: Add a method description

def create_send_sms(self,
                        api_key,
                        to,
                        sms,
                        mfrom)

Parameters

Parameter	Tags	Description
apiKey	Required DefaultValue	set your API_KEY from http://sms.cynojine.com/sms-api/info (user panel)
to	Required DefaultValue	the number we are sending to - Any phone number
sms	Required	SMS Body
mfrom	Required	Change the from number below. It can be a valid phone number or a String

Example Usage

api_key = 'xxxxxxxxxxxxx'
to = '260986'
sms = 'sms'
mfrom = 'from'

result = client_controller.create_send_sms(api_key, to, sms, mfrom)

get_balance_check

Checking SMS Balance

def get_balance_check(self,
                          options=dict(),
                          _optional_query_parameters=None)

Parameters

Parameter	Tags	Description
apiKey	Required	Get your account balance
response	Required DefaultValue	Json Responce
_optional_query_parameters	Optional	Additional optional query parameters are supported by this method

Example Usage

collect = {}

api_key = 'api_key'
collect['api_key'] = api_key

response = 'json'
collect['response'] = response

# key-value map for optional query parameters
optional_query_parameters = { }


client_controller.get_balance_check(collect, optional_query_parameters, )

Back to List of Controllers