Skip to main content

SMSWithoutBorders OpenAPI

SMSWithoutBorders OpenAPI integrates a simple queueing system with RabbitMQ, which allows developers managing outgoing SMS messages from their Gateway clients.

What you'll learn
  • How to setup and use OpenAPI

The most recent version of this guide can be found in the github reposistory

The frontend integrates with these services. you may need to set them up depending on what section you are working on.

Table of contents​

  1. Requirements
  2. Dependencies
  3. Installation
  4. Setup

Requirements​

Dependencies​

This project contains submodules. To clone all submodules use

git submodule update --init --recursive --remote

Setup RabbitMQ Server

  • Move into the RabbitMQ directory in the repo
cd RabbitMQ

On Ubuntu libmysqlclient-dev is required

sudo apt install python3-dev libmysqlclient-dev

Installation​

Create a Virtual Environments (venv)

python3 -m venv venv

Move into Virtual Environments workspace

. venv/bin/activate

Install all python packages

python -m pip install -r requirements.txt

Setup​

All configuration files are found in the config directory.

Development configurations​

default.ini is the configuration file.

To set up the API, copy the template files "example.default.ini" and rename to "default.ini"

cp config/example.default.ini config/default.ini

Access configurations​

setup.ini is the access file.

To set up access, copy the template files "example.setup.ini" and rename to "setup.ini"

cp example.setup.ini setup.ini

How to use​

Start API​

python3 server.py

API SandBox​

<host>:<PORT>/<VERSION>/api-docs/