https://github.com/pgrimaud/myne
School project
https://github.com/pgrimaud/myne
Last synced: 4 months ago
JSON representation
School project
- Host: GitHub
- URL: https://github.com/pgrimaud/myne
- Owner: pgrimaud
- Created: 2014-04-29T12:53:48.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-07T08:02:19.000Z (almost 11 years ago)
- Last Synced: 2025-01-06T09:11:34.853Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 3.99 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Myne
## API - Introduction
Cette API permet aux clients de récupérer des informations, reviews et commentaires sur leurs produits.
## REST
API server : http://myne.api
L'API est principalement RESTful. Les données sont exposées sous la forme d'URI qui représentent des ressources et peuvent être récupérés via des clients HTTP (comme les navigateurs web) avec authentification.
## Authentification et type de données renvoyées
Pour accéder à une donnée il suffit simplement de passer dans l'entête HTTP votre token et le type content-type souhaité.
*Construction d'une requête authentifiée*
GET Host+ /comments?id_review=1
Host: myne.api
X-Myne-Token: 6a52f85027a5477719d6c650ea3338fd
Content-Type: application/json | application/xml
## Requêtes products
Ces requêtes permettent de récupérer les produits du client.
*Example de requête products*
GET /products HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
12345678901233
Product YOLO
2
12345678901233
Product TEST
*Fichier retourné (JSON)*
{"products":[{"SKU":"1","ean_code":"12345678901233","name":"Product YOLO"},{"SKU":"2","ean_code":"12345678901233","name":"Product TEST"}]}
## Requêtes product
Ces requêtes permettent de récupérer un produit spécifique du client.
*Example de requête product*
GET /product/1 HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
12345678901233
Product YOLO
*Fichier retourné (JSON)*
{"product":{"SKU":"1","ean_code":"12345678901233","name":"Product YOLO"}}
## Requêtes reviews
Ces requêtes permettent de récupérer les reviews d'un produit du client.
*Example de requête reviews*
GET /reviews?id_product=1 HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
Ce produit est superbe!
Super produit! (...)
10
2014-06-23 00:00:00
123456789
Pierre
Grimaud
2
Déçu....
Ce produit n'est pas super (...)
2
2014-06-23 00:00:00
123456789
Jerôme
Duval
*Fichier retourné (JSON)*
{"reviews":[{"id_review":"1","title":"","content":"Super produit!","rate":"10","date":"2014-06-23 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"},{"id_review":"2","title":"","content":"Pue la merde","rate":"1","date":"2014-06-20 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"}]}
## Requêtes review
Ces requêtes permettent de récupérer une review spécifique d'un produit du client.
*Example de requête review*
GET /review/1 HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
Ce produit est superbe!
Super produit! (...)
10
2014-06-23 00:00:00
123456789
Pierre
Grimaud
*Fichier retourné (JSON)*
{"review":{"id_review":"1","title":"","content":"Super produit!","rate":"10","date":"2014-06-23 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"}}
## Requêtes comments
Ces requêtes permettent de récupérer les commentaires d'une review d'un produit du client.
*Example de requête comments*
GET /comments?id_review=1 HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
Je suis d'accord!
2014-06-18 00:00:00
123456789
Paul
Nhyou
2
Ouais! Trop bien!
2014-06-18 00:00:00
123456789
Hervé
Tran
*Fichier retourné (JSON)*
{"comments":[{"id_comment":"1","content":"Je suis d'accord!","date":"2014-06-18 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"},{"id_comment":"2","content":"Non, tu est nul.","date":"2014-06-10 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"}]}
## Requêtes comment
Ces requêtes permettent de récupérer un commentaire d'une review d'un produit du client.
*Example de requête comment*
GET /comment/1 HTTP/1.1
Content-Type: application/xml
Host: myne.api
Date: Sun, 12 June 2014 16:59:24 GMT
*Fichier retourné (XML)*
1
Je suis d'accord!
2014-06-18 00:00:00
123456789
Paul
Nhyou
*Fichier retourné (JSON)*
{"comment":{"id_comment":"1","content":"Je suis d'accord!","date":"2014-06-18 00:00:00","id_facebook":"123456789","first_name":"Pierre","last_name":"Grimaud"}}