Public
Documentation Settings
No Environment
Double Column
cURL - cURL
django-backend
Introduction
Overview
Error Codes
POST
Sign up
POST
Login
POST
Create Portfolio for the loggedin user
POST
Education field fillup
POST
Create work experience for the loggedin user
POST
create projects
GET
GET project details
POST
Create skills for logged in user
POST
about loggedin user detail
GET
The complete Portfolio

django-backend

The documentation is part of the this project

  • The API's manage the complete backend interaction with django models.

Overview

The concerned user should understand the working of a portfolio website and on that basis, he/she will be easily liable to change or customize the API's for their own purpose.

Error Codes

What errors and status codes can a user expect? The error codes are the standard error codes of HTTP methods.

POSTSign up

http://127.0.0.1:8080/api/signup/

POST user details for signup

Bodyformdata
email

newuser@user.com

New user email

name

newuser

new user name

password

user123

new user password

Example Request
Sign up
curl
curl --location 'http://127.0.0.1:8080/api/signup/' \
--form 'email="newuser1@user.com"' \
--form 'name="newuser1"' \
--form 'password="user123"'
201 Created
Example Response
json
{
  "data": {
    "id": 8,
    "email": "newuser@user.com",
    "name": "newuser"
  },
  "summary": {
    "statusCode": 201,
    "status": "success"
  }
}
Date

Tue, 28 Apr 2020 20:54:30 GMT

Server

WSGIServer/0.2 CPython/3.5.2

Allow

GET, POST, HEAD, OPTIONS

Content-Type

application/json

Vary

Accept

Content-Length

109

X-Frame-Options

SAMEORIGIN

POSTLogin

http://127.0.0.1:8080/api/login/

Login using the signup credentials

Bodyformdata
username

newuser@user.com

Use the previous email as the username

password

user123

use the password same as during signup

Example Request
Logged in
curl
curl --location 'http://127.0.0.1:8080/api/login/' \
--form 'username="newuser@user.com"' \
--form 'password="user123"'
200 OK
Example Response
json
{
  "token": "c2c6cb7771a07034257177f82477ce0d06c073fb"
}
Date

Tue, 28 Apr 2020 21:17:14 GMT

Server

WSGIServer/0.2 CPython/3.5.2

Allow

POST, OPTIONS

Content-Type

application/json

Vary

Accept, Cookie

Content-Length

52

X-Frame-Options

SAMEORIGIN

POSTCreate Portfolio for the loggedin user

http://127.0.0.1:8080/api/portfolio-update/

Create a portfolio for the corresponding loggedin user. Each user could only create one portfolio at a time. The portfolio could be accessbile by the public url api/user/user_name

HEADERS
Authorization

Token c2c6cb7771a07034257177f82477ce0d06c073fb

Content-Type

application/x-www-form-urlencoded

Bodyformdata
name

test user

write name that should be displayed in portfolio

email

testuseremail@email.com

Write email that should be displayed in portfolio

Example Request
http://127.0.0.1:8080/api/portfolio-update/
curl
curl --location 'http://127.0.0.1:8080/api/portfolio-update/' \
--header 'Authorization: Token c2c6cb7771a07034257177f82477ce0d06c073fb' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'name="test user"' \
--form 'email="testuseremail@email.com"'
201 Created
Example Response
json
{
  "data": {
    "url": "http://127.0.0.1:8080/api/portfolio-update/2/",
    "name": "test user",
    "created_on": "2020-04-28T21:27:43.406909Z",
    "email": "testuseremail@email.com",
    "skill": [],
    "work_experience": [],
    "about": [],
    "achievement": [],
    "interest": [],
    "certification": [],
    "project": [],
    "education": [],
    "avatar": null
  },
  "summary": {
    "statusCode": 201,
    "status": "success"
  }
}
Date

Tue, 28 Apr 2020 21:27:43 GMT

Server

WSGIServer/0.2 CPython/3.5.2

Allow

GET, POST, HEAD, OPTIONS

Content-Type

application/json

Location

http://127.0.0.1:8080/api/portfolio-update/2/

Content-Length

343

X-Frame-Options

SAMEORIGIN

Vary

Accept