bryanbill / django_api

DJANGO API

Installation

1. Clone this repo to your local directory
2. Enable python virtual environment in the source directory
3. Run pip3 install -r requirements.txt to install all the required packages
4. Run python3 manage.py makemigrations
5. Go to graph_api.schema and replace the api_key = "" with your api key
6. Run python3 manage.py migrate
7. Run python3 manage.py migrate --run-syncdb
8. Create a super user for securing the api python3 manage.py createsuperuser and follow the prompts
9. Run python3 manage.py migrate loaddata dummy.json
10. Run python3 manage.py runserver to start the server at https://127.0.01/8000

Retrieving Data

The program when started runs locally on port 8000. This opens an admin page that'll require a login.

Creating a simple query

Navigate to https://127.0.01/8000/admin/graphql in your browser to access a graphiql user interface.

Getting all Customers

    query getCustomers{
        customers{
            code
            name
            orders{
                item
                amount
            }
        }
    }

Getting all Orders

    query getOrders{
        orders{
            item
            amount
            time
        }
    }

Creating an Order

mutation createOrder {
    createOrder(input: {item: "Tortillas", amount: 200, time: 2300}) {
    ok
    order {
      item
      amount
      time
    }
  }
}

Creating a Customer

mutation createCustomer {
    createCustomer(input: {code: 714044854, name: "Tom Hanks", orders: [{id: 1}, {id: 2}]}) {
    ok
    customer {
      code
      orders {
        id
        item
        amount
        time
      }
    }
  }
}

Africastalking SMS integration

In your project's root directory, rename .env.sample to .env and fill in the variable names with the corresponding values from Africastalking SDK

When the mutation for creating a new customer having a particular order is run, the api automatically takes the code, user's phone numner and sends an order complete message