Skip to content

Latest commit

 

History

History
774 lines (671 loc) · 14.7 KB

READMEBack.md

File metadata and controls

774 lines (671 loc) · 14.7 KB
Raw

Table of Contents

User

Create User ["check"]

  • URL: /user
  • Method: POST
  • Description: Create a new user.
  • Request: User data to be created.
Required Optional
nickname email
password is_professional
last_name company_name
first_name unique_company_number
phone_number image
age 
{
  "nickname": "pseudo",
  "password": "mot_de_passe",
  "last_name": "Nom",
  "first_name": "Prenom",
  "phone_number": "numero_telephone",
  "age": "22"
}
  • Response: The created user object. Status Created 201
{
  "id": 1,
  "nickname": "pseudo",
  "email": "",
  "is_active": true,
  "date_joined": "2023-08-18T19:06:15.249934Z",
  "first_name": "Prenom",
  "last_name": "Nom",
  "phone_number": "numero_telephone",
  "age": 22,
  "is_professional": false,
  "company_name": "",
  "unique_company_number": "",
  "image": null
}

Update User ["check"]

  • URL: /user
  • Method: PUT
  • Description: Update user information.
  • Need Authentication:

Password fields is Removed in the Required

Required Optional
nickname email
last_name is_professional
first_name company_name
phone_number unique_company_number
age image 
Authorization: token 0cb6a0cc962b5211960676ae9a20ad650c206db2
  • Request: Updated user data.
{
  "nickname": "pseudo",
  "last_name": "Nom",
  "first_name": "Prenom",
  "phone_number": "numero_telephone",
  "age": "22"
}
  • Response: The created user object. Status Accepted 202
{
  "id": 1,
  "nickname": "pseudo",
  "email": "",
  "is_active": true,
  "date_joined": "2023-08-18T19:06:15.249934Z",
  "first_name": "Prenom",
  "last_name": "Nom",
  "phone_number": "numero_telephone",
  "age": 22,
  "is_professional": false,
  "company_name": "",
  "unique_company_number": "",
  "image": null
}

Get User ["check"]

  • URL: /user/<int:pk>
  • Method: GET
  • Description: Retrieve user details.
  • Response: The requested user object. Status Ok 200
{
  "id": 1,
  "nickname": "pseudo",
  "email": "",
  "is_active": true,
  "date_joined": "2023-08-18T19:06:15.249934Z",
  "first_name": "Prenom",
  "last_name": "Nom",
  "phone_number": "numero_telephone",
  "age": 22,
  "is_professional": false,
  "company_name": "",
  "unique_company_number": "",
  "image": null
}

Delete User

  • URL: /user/<int:pk>
  • Method: DELETE
  • Description: Delete a user.
  • Need Authentication:
Authorization: token 0cb6a0cc962b5211960676ae9a20ad650c206db2
  • Response: No content. Status No content 204

Authentication

User Authentication Token ["check"]

  • URL: /user/auth
  • Method: POST
  • Description: Authenticate a user.
  • Request: Credential.
{
  "phone_number": "numero_telephone",
  "password": "mot_de_passe"
}
  • Response: User authentication token. Status Ok 200
{
  "token": "926c06bd87e786e085a72b163e0d8e26f1ec6b11"
}

Category

List Categories ["check"]

  • URL: /category
  • Method: GET
  • Description: Retrieve all categories.
[
  {
    "id": 1,
    "name": "category_name",
    "image": null
  },
  {
    "id": 2,
    "name": "category_name",
    "image": null
  }
]

SubCategory

List SubCategories ["check"]

  • URL: /subcategory/<int:id_category>
  • Method: GET
  • Description: Retrieve all subcategories of a category.
[
  {
    "id": 1,
    "criteria": [
      {
        "id": 1,
        "response": [
          {
            "value": "CDD"
          },
          {
            "value": "CDI"
          },
          {
            "value": "Intérim"
          },
          {
            "value": "Autre"
          }
        ],
        "name": "Type de contrat",
        "type": "choice"
      },
      {
        "id": 2,
        "response": [],
        "name": "Secteur d'activité",
        "type": "text"
      },
      {
        "id": 3,
        "response": [],
        "name": "Fonction",
        "type": "text"
      },
      {
        "id": 4,
        "response": [
          {
            "value": "0 à 2 ans"
          },
          {
            "value": "2 à 5 ans"
          },
          {
            "value": "plus de 5 ans"
          }
        ],
        "name": "Expérience",
        "type": "choice"
      },
      {
        "id": 5,
        "response": [
          {
            "value": "CP"
          },
          {
            "value": "BEPC"
          },
          {
            "value": "BAC"
          },
          {
            "value": "BAC +2"
          },
          {
            "value": "BAC +3"
          },
          {
            "value": "BAC +5"
          }
        ],
        "name": "Niveau d'etudes",
        "type": "choice"
      },
      {
        "id": 6,
        "response": [
          {
            "value": "Temps partiel"
          },
          {
            "value": "Temps plein"
          }
        ],
        "name": "Travail à",
        "type": "choice"
      },
      {
        "id": 7,
        "response": [],
        "name": "Reference",
        "type": "text"
      }
    ],
    "nom": "Offre d'emploi",
    "category": 1
  }
]

Vendeur Favoris

Add new Favoris ["check"]

  • URL: /follow/seller
  • Method: Post
  • Description: follow other user
  • Need Authentication:
  • Request:
{
  "seller_id": 1
}
  • Response
{
  "id": 1,
  "seller": {
    "id": 1,
    "nickname": "nickname",
    "image": null
  },
  "timestamp": "2023-09-06T17:53:41.890339Z"
}

List all follow ["check"]

  • URL: /follow/seller

  • Method: Get

  • Description:

  • Need Authentication:

  • Response: Status Ok 200

[
  {
    "id": 1,
    "seller": {
      "id": 1,
      "nickname": "nickname",
      "image": null
    },
    "timestamp": "2023-09-06T17:53:41.890339Z"
  }
]

Delete favoris ["check"]

  • URL: /follow/seller/<int:pk>
  • Method: Delete
  • Description:
  • Need Authentication:
  • Response: Status No content 204

Product

Create Product

  • URL: /product
  • Method: POST
  • Description: Create a new product.
  • Need Authentication:
  • Request: Product data to be created.
Required Optional
name uploaded_images
description list_payement_method
location payement_integrate: bool
price quantity: int
sub_category type: char
seller local_delivery_price
national_delivery_price
email_contact
phone_number_contact

type: [Recherche, Offre]

{
  "uploaded_images": [],
  "list_payement_method": [],
  "name": "Dev Java",
  "description": "Cherche un developpeur java Export en spring boot",
  "location": "e-tech",
  "price": 10000,
  "sub_category": 1,
  "seller": 1
}
  • Response: Status Created 201
{
  "id": 1,
  "pictures": [],
  "payement_method": [
    {
      "id": 1,
      "user": "joe",
      "name": "MobileMoney",
      "phone": "0325911514",
      "card_number": null,
      "expiration_date": null,
      "cvv": null
    }
  ],
  "product_criteria": [],
  "name": "Dev Java",
  "publication_date": "2023-09-02T13:25:25.350589Z",
  "description": "Cherche un developpeur java Export en spring boot",
  "location": "e-tech",
  "price": "10000.00",
  "local_delivery_price": null,
  "national_delivery_price": null,
  "payement_integrate": true,
  "expiration": 3,
  "quantity": 1,
  "type": "Offre",
  "state": "Activé",
  "email_contact": null,
  "phone_number_contact": null,
  "sub_category": 1,
  "seller": 2,
  "likes": [],
  "views": []
}

Update Product

  • URL: /product/<int:pk>
  • Method: PUT
  • Description: Update product information.
  • Need Authentication:
  • Request: Updated product data.
{
  "uploaded_images": [],
  "list_payement_method": [],
  "name": "Dev Java",
  "description": "Cherche un developpeur java Export en spring boot",
  "location": "e-tech",
  "price": 10000,
  "sub_category": 1,
  "seller": 1
}
  • Response:
{
  "id": 1,
  "pictures": [],
  "payement_method": [
    {
      "id": 1,
      "user": "joe",
      "name": "MobileMoney",
      "phone": "0325911514",
      "card_number": null,
      "expiration_date": null,
      "cvv": null
    }
  ],
  "product_criteria": [],
  "name": "Dev Java",
  "publication_date": "2023-09-02T13:25:25.350589Z",
  "description": "Cherche un developpeur java Export en spring boot",
  "location": "e-tech",
  "price": "10000.00",
  "local_delivery_price": null,
  "national_delivery_price": null,
  "payement_integrate": true,
  "expiration": 3,
  "quantity": 1,
  "type": "Offre",
  "state": "Activé",
  "email_contact": null,
  "phone_number_contact": null,
  "sub_category": 1,
  "seller": 2,
  "likes": [],
  "views": []
}

Get Product ["check"]

  • URL: /product/<int:pk>
  • Method: GET
  • Description: Retrieve product details.
  • Response:
{
  "id": 1,
  "pictures": [],
  "payement_method": [
    {
      "id": 1,
      "user": "joe",
      "name": "MobileMoney",
      "phone": "0325911514",
      "card_number": null,
      "expiration_date": null,
      "cvv": null
    }
  ],
  "product_criteria": [],
  "name": "Dev Java",
  "publication_date": "2023-09-02T13:25:25.350589Z",
  "description": "Cherche un developpeur java Export en spring boot",
  "location": "e-tech",
  "price": "10000.00",
  "local_delivery_price": null,
  "national_delivery_price": null,
  "payement_integrate": true,
  "expiration": 3,
  "quantity": 1,
  "type": "Offre",
  "state": "Activé",
  "email_contact": null,
  "phone_number_contact": null,
  "sub_category": 1,
  "seller": 2,
  "likes": [],
  "views": []
}

Get All Product ["check"]

  • URL: /product

  • Method: GET

  • Description: Retrieve all product.

  • Response:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "pictures": [],
      "payement_method": [
        {
          "id": 1,
          "user": "joe",
          "name": "MobileMoney",
          "phone": "0325911514",
          "card_number": null,
          "expiration_date": null,
          "cvv": null
        }
      ],
      "product_criteria": [],
      "name": "Dev Java",
      "publication_date": "2023-09-02T13:25:25.350589Z",
      "description": "Cherche un developpeur java Export en spring boot",
      "location": "e-tech",
      "price": "10000.00",
      "local_delivery_price": null,
      "national_delivery_price": null,
      "payement_integrate": true,
      "expiration": 3,
      "quantity": 1,
      "type": "Offre",
      "state": "Activé",
      "email_contact": null,
      "phone_number_contact": null,
      "sub_category": 1,
      "seller": 2,
      "likes": [],
      "views": []
    }
  ]
}

Delete product

  • URL: /product/<int:pk>
  • Method: Delete
  • Description: Delete product.
  • Need authentication

PayementMethod

Create PayementMethod ["check"]

  • URL: /payementmethod
  • Method: POST
  • Description: Create a new payement method.
  • Need Authentication:
Required Optional
name : [MobileMoney, Paypal, VISA, Payé à la Livraison] phone
card_number
expiration_date
cvv
  • Request:
{
  "name": "MobileMoney",
  "phone": "0325911514"
}
  • Response: Created 201
{
  "name": "MobileMoney",
  "phone": "0325911514",
  "card_number": null,
  "expiration_date": null,
  "cvv": null
}

Update PayementMethod

  • URL: /payementmethod/<int:pk>
  • Method: PUT
  • Description: Update payement method.
  • Need Authentication:
  • Request:
{
  "name": "MobileMoney",
  "phone": "0337015514"
}
  • Response: Accepted 202
{
  "name": "MobileMoney",
  "phone": "0337015514",
  "card_number": null,
  "expiration_date": null,
  "cvv": null
}

Get PayementMethod ["check"]

  • URL: /payementmethod/<int:pk>
  • Method: GET
  • Description: Retrieve payement method.
  • Need Authentication:
  • Response: Ok 200
{
  "name": "MobileMoney",
  "phone": "0337015514",
  "card_number": null,
  "expiration_date": null,
  "cvv": null
}

Get All PayementMethod ["check"]

  • URL: /payementmethod
  • Method: GET
  • Description: Get all list payement method.
  • Need Authentication:
  • Response: Ok 200
[
  {
    "name": "MobileMoney",
    "phone": "0337015514",
    "card_number": null,
    "expiration_date": null,
    "cvv": null
  }
]

Delete PayementMethod

  • URL: /payementmethod/<int:pk>
  • Method: DELETE
  • Description: Delete payement methode
  • Need Authentication:
  • Response: Nocontent 204

Notification

List Notification ["check"]

  • URL: /notification
  • Method: GET
  • Description: Get all list notification.
  • Need Authentication:
  • Response: Ok 200
[
  {
    "id": 1,
    "title": "title",
    "description": "description",
    "date": "2023-09-06T18:06:15.249934Z",
    "is_read": false,
    "user": 1
  }
]

Delete Notification

  • URL: /notification/<int:pk>
  • Method: DELETE
  • Description: Delete notification
  • Need Authentication:
  • Response: Nocontent 204

RealTime Notification with websocket ["check"]

// notificaiton/<nickname>
const chatSocket = new WebSocket(
  "ws://localhost:8000/ws/notification/<nickname>",
  ["access_token", "<Token>"],
);

// verify connection
chatSocket.onopen = function (e) {
  console.log("The connection was setup successfully !");
};
// verify error
chatSocket.onclose = function (e) {
  console.log("Something unexpected happened !");
};

// receive message
chatSocket.onmessage = function (e) {
  const data = JSON.parse(e.data);
  console.log(data);
};