MdNotes-CC 1.0

API for Markdown Notes app.

Getting started

API for Markdown Notes app.

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 MdNotesCc 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 md_notes_cc.md_notes_cc_client import MdNotesCcClient

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

Authentication

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

Parameter	Description
o_auth_client_id	OAuth 2 Client ID
o_auth_client_secret	OAuth 2 Client Secret

API client can be initialized as following.

# Configuration parameters and credentials
o_auth_client_id = 'o_auth_client_id' # OAuth 2 Client ID
o_auth_client_secret = 'o_auth_client_secret' # OAuth 2 Client Secret

client = MdNotesCcClient(o_auth_client_id, o_auth_client_secret)

You must now authorize the client.

Authorizing your client

This SDK uses OAuth 2.0 authorization to authorize the client.

The authorize() method will exchange the OAuth client credentials for an access token. The access token is an object containing information for authorizing client requests.

You must pass the scopes for which you need permission to access.

try:
    client.auth.authorize([OAuthScopeEnum.NOTES_READ])
except OAuthProviderException as ex:
    # handle exception

The client can now make authorized endpoint calls.

Scopes

Scopes enable your application to only request access to the resources it needs while enabling users to control the amount of access they grant to your application. Available scopes are defined in the md_notes_cc.models.o_auth_scope_enum.OAuthScopeEnum enumeration.

Scope Name	Description
NOTES_READ	notes read access

Storing an access token for reuse

It is recommended that you store the access token for reuse.

You can store the access token in a file or a database.

# store token
save_token_to_database(client.config.o_auth_token)

Creating a client from a stored token

To authorize a client from a stored access token, just set the access token after creating the client:

client = MdNotesCcClient()
client.config.o_auth_token = load_token_from_database()

Complete example

from md_notes_cc.md_notes_cc_client import MdNotesCcClient
from md_notes_cc.models.o_auth_scope_enum import OAuthScopeEnum
from md_notes_cc.exceptions.o_auth_provider_exception import OAuthProviderException

# function for storing token to database
def save_token_to_database(token):
    # code to save the token to database

# function for loading token from database
def load_token_from_database():
    # load token from database and return it (return None if no token exists)

# Configuration parameters and credentials
o_auth_client_id = 'o_auth_client_id' # OAuth 2 Client ID
o_auth_client_secret = 'o_auth_client_secret' # OAuth 2 Client Secret

#  create a new client
client = MdNotesCcClient(o_auth_client_id, o_auth_client_secret)

# obtain access token, needed for client to be authorized
previous_token = load_token_from_database()
if previous_token:
    # restore previous access token
    client.config.o_auth_token = previous_token
else:
    # obtain new access token
    try:
        token = client.auth.authorize([OAuthScopeEnum.NOTES_READ])
        save_token_to_database(token)
    except OAuthProviderException as ex:
        # handle exception

# the client is now authorized and you can use controllers to make endpoint calls

Class Reference

List of Controllers

• ServiceController
• UserController

ServiceController

Get controller instance

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

 service_controller = client.service

get_status

TODO: Add a method description

def get_status(self)

Example Usage

result = service_controller.get_status()

Back to List of Controllers

UserController

Get controller instance

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

 user_controller = client.user

get_user

TODO: Add a method description

def get_user(self)

Example Usage

result = user_controller.get_user()

Back to List of Controllers