/printify-api-lauris

Primary LanguagePHP

PRINTIFY PRODUCT API

This is an API which allows to add and view products.

It is also possible to create order consisting of products and view orders.

Below is each endpoint of the API and how to access it.

PROJECT FOLDER STRUCTURE

printify-api-lauris
├── api [source files for each endpoint]
    ├── add-order.php [endpoint for adding an order]
    ├── add-product.php [endpoint for adding a product]
    ├── view-orders.php [endpoint for viewing orders]
    ├── view-product.php [endpoint for viewing a specific product]
    ├── view-products.php [endpoint for viewing all products]
├── config
    ├── Database.php [file to set up connection with mysql database within docker container]
    ├── request-filter.php [limits possible requests from a country]
├── invoice-generator [files for generating order invoice after submitting order to API]
├── mysql-dump [file with 4 empty tables - products, orders, orders_products, country_codes]
├── order-drafts [order invoices are saved here in pdf form]
├── php-apache [Dockerfile for php running on apache with mysqli, pdo support]
├── utils [two classes with functionality to manipulate 4 tables within printify-products database]
.gitignore
README.md
docker-compose.yml [used to create images for php, mysql, phpmyadmin and launch them]

INSTALLATION

In root directory run

docker-compose up

USAGE

Endpoints can be accessed at port 80:

http://localhost/api/endpoint

phpMyAdmin can be accessed at port 8080 with username root and password root

http://localhost:8080/

ENDPOINTS

add-product.php

POST request

Add a product

http://localhost/api/add-product.php

{
	"price": 10,
	"productType": "socks",
	"color": "yellow",
	"size": "L"
}

view-product.php

GET request

View one product by it's id

http://localhost/api/view-product.php?id=1

view-products.php

GET request

View all products

http://localhost/api/view-products.php

add-order.php

POST request

Add an order

http://localhost/api/add-order.php

(product ID) : (quantity)

{
	"1" : "2",
	"2" : "2"
}

view-orders.php

GET request

Viewing orders

http://localhost/api/view-orders.php

Viewing orders that contain item of a specific type of product

http://localhost/api/view-orders.php?type=socks

RESTRICTING CONNECTIONS

By default, it is set that in 1 minute 5 requests from country are allowed.

To change that, go to config/request-filter.php and change $requestsPerMinuteLimit = 5;

to your desired value.