Rest API Documentation

Introduction

Create Token

Delete Token

Create Record

Get Data

Update Record

Delete Record

How to enable model for Rest API

Introduction
Token generation is an essential process, which will be used further in deletion of token; requesting database for creating, updating, deleting and fetching data.

Create Token
The following procedure is to create token.

Parameter Description
username Your account email
password Your account password
db Specify the Database name
import requests

db_config = {
    "username": "YOUR_EMAIL",
    "password": "YOUR_PASSWORD",
    "db": "SERVER_DATABASE_NAME"
}

server_url = "YOUR_SERVER_URL"
get_token_url = "/api/auth/get_tokens"
url = server_url + get_token_url

requests.post(url=url, data=db_config)

# Output:

{
    "company_id": 1,
    "user_context": {
            "lang": "en_US",
            "tz": "Asia/Kolkata",
            "uid": 1
        },
    "access_token": "YOUR_API_ACCESS_TOKEN",
    "expires_in": "600",
    "uid": 1
}

Delete Token

Parameter Description
access_token Your API Access Token
import requests

header = {
    "access_token": "YOUR_API_ACCESS_TOKEN"
}
server_url = "YOUR_SERVER_URL"
del_token_url = "/api/auth/delete_tokens"
url = server_url + del_token_url

requests.post(url=url, headers=header)

# Output:
{
    "desc": "Token Successfully Deleted",
    "delete": true
}

Create Record
Header Parameter

Parameter Description
access_token Your API Access Token

Data Parameter

Parameter Description
fields N number of fields for creating records

 

HTTP POST URL ‘/api/<MODEL NAME>’

import requests

header = {
    "access_token": "YOUR_API_ACCESS_TOKEN"
}

data = {
    "name": "Multitouch Pro",
    "email": "example@multitouchpro.com",
    "website": "www.multitouchpro.com"
}

server_url = "YOUR_SERVER_URL"
post_url = '/api/res.partner'
url = server_url + post_url

requests.post(url=url, data=data, headers=header)

# output:
{
    "id": 300
}