E-Commerce API

---

Project number 7 of Openclassrooms "Developpeur d'application PHP / Symfony" cursus

The objectif of this project is to create a web service with an API.

Code quality

Demontration

Preview example : http://bilemo.oodie.fr

• /login Authenticate
• /tokens Get JWT
• /apidoc API Documents

Installation

1 - Download or clone the repository git

git clone https://github.com/sebastien-chomy/oc_bilemo.git my_project

2 - Generating the Public and Private Key

from /my_project/config/jwt/

Create the Public and Private key to access the API by reading the following instructions Readme

3 - Download dependencies

from /my_project/

composer install

Before you start using Composer, you must first install it on your system. https://getcomposer.org/

Create database, schema and load data fixtures

Follow these steps

1 - Create database

From /my_project/

php bin/console doctrine:database:create

2 - Create schema

From /my_project/

php bin/console doctrine:schema:create

OR

php bin/console doctrine:schema:update --force

3 - Fixtures of data

From /my_project/

php bin/console doctrine:fixture:load

4 - Preparation

From /my_project/

php bin/console cache:clear --env=prod 

Configuration

For that project works it is necessary to change a file /my_project/.env

###> symfony/framework-bundle ###
APP_ENV=<Your environment dev|test|prod>
APP_SECRET=d6e73c5232ea0cabd4c4f86a69653eeb
###< symfony/framework-bundle ###

###> doctrine/doctrine-bundle ###
# Format described at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
# For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
# Configure your db driver and server_version in config/packages/doctrine.yaml
DATABASE_URL=mysql://db_user:[email protected]:3306/db_name
###< doctrine/doctrine-bundle ###

###> lexik/jwt-authentication-bundle ###
# Key paths should be relative to the project directory
JWT_PRIVATE_KEY_PATH=config/jwt/private.pem
JWT_PUBLIC_KEY_PATH=config/jwt/public.pem
JWT_PASSPHRASE=<Your passphrase>
JWT_TTL=3600
###< lexik/jwt-authentication-bundle ###

VirtualHost

<VirtualHost *:80>
	ServerName oc_bilemo.local
	DocumentRoot "path/to/my/project/public"
	AddDefaultCharset utf-8

	<Directory  "path/to/my/project/public">
		DirectoryIndex index.php
		Options Indexes FollowSymlinks
		Require all granted
		AllowOverride None

		<IfModule rewrite_module>
			RewriteEngine On
			RewriteCond %{HTTP:Authorization} ^(.*)
			RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]						
			RewriteCond %{REQUEST_FILENAME} !-f
			RewriteRule ^(.*)$ index.php [QSA,L]
		</IfModule>
	</Directory>
	ErrorLog logs/oc_bilemo-error.log
	CustomLog logs/oc_bilemo-access.log combined
</VirtualHost>

Usage

Authentication

For be authentified to API you need to obtain an access token from JWT. There are two options with this test user:

{ "username": "customer_1", "password": "12345" }

Use APIDoc

From http://oc_bilemo.local/apidoc and POST /api/login sandbox. Give username, password value and execute to get the token as follows.

{
    "token": "eyJhbGciOiJSUzI1NiJ9.eyJyb2xlcyI6WyJST0xFX0FQSV9VU0VSIl0sInVzZXJuYW1lIjoiY3VzdG9tZXJfMSIsImlhdCI6MTUyNzA3NTMyMiwiZXhwIjoxNTI3MDc4OTIyfQ.Q0boOWli_pNPZmby6WZp08_Ks8970Zjt1pqt6XOz5nt-NtZKEvPI51ErTkMLhxUtGqEadYvGJIyQ ..."
}

Use the frontend

From the frontend on this url : /login then /tokens to obtained this token.

API Document

Screenshot ApiDoc