API Responses

POST //paperdb.io/api/user/authenticate

Request-Headers:

                                    
{
Accept: application/json
Content-Type: application/json
}

Parameters

Input
Username String Mandatory
Password String Mandatory

Request Example

Request URL

https://paperdb.io/api/user/authenticate

Server Response

Response Body

                                        
{
 "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImRlOGZlMzQxNzAxNTRiYWQwN2Q3ZDQxOGQwNzMwMDU5ODNhMGFhNzE5MzFlNjIwOWQ1MDdiMjY2MTI0YjM3NzIzOTMyZmU2MWZlODhkNDg2In0.eyJhdWQiOiIP0ApajvNZQet6fNBwipOng--C7QRE_Czra6uLBA7Tgdr184akj1ewor0eHkTZv_ajf909CYxFKIBPnLwE4JnGEwXGdtVf7Q-i8PdmK2m0czOov1-Wzwayl7qo828Equr2sfmgky4Q4vI-Ffet_yobZv60XqAxAn7Jm1_V4NGe3w6Smi0DSjpgEnkS5e4ERdWlI68PFJ9AvREPWcenNIOKhXSHK29gZ9C8EscHYTZGyZIfGtAKwnnSuJV3x89uEZbajqpbnNpEftgT_argGQNxKhgU1QkQtsK0Pqpk8G5UfU-iFcQkX_wEZqTTsFwz0dDUcgUwjCtZgvoIUshfZVFxlvBLf64es7jdvGvTTlUhX7sUMku1A-gy5SiMVnFyW_MIb1TZVlF7b5bHQ",
     "user": {
         "id": 3,
         "name": "john clarke",
         "email": "dummy@paperdb.io",
         "username": "john_dummy",
         "created_at": "2018-05-04 05:02:23",
         "updated_at": "2018-05-04 05:02:23",
     }
 }
}

GET //paperdb.io/api/GetArchtype

Request-Headers:

                                    
{
Accept: application/json
Content-Type: application/json
Authorization :Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImRlOGZlMzQxNzAxNTRiYWQwN2Q3ZDQxOGQwNzMwMDU5ODNhMGFhNzE5MzFlNjIwOWQ1MDdiMjY2MTI0YjM3NzIzOTMyZmU2MWZlODhkNDg2In0.eyJhdWQiOiIxIiwianRpIjoiZGU4ZmUzNDE3MDE1NGJhZDA3ZDdkNDE4ZDA3MzAwNTk4M2EwYWE3MTkzMWU2MjA5ZDUwN2IyNjYxMjRiMzc3MjM5MzJmZTYxZmU4OGQ0ODYiLCJpYXQiOjE1MjU3NTM3MTYsImf909CYxFKIBPnLwE4JnGEwXGdtVf7Q-i8PdmK2m0czOov1-Wzwayl7qo828Equr2sfmgky4Q4vI-Ffet_yobZv60XqAxAn7Jm1_V4NGe3w6Smi0DSjpgEnkS5e4ERdWlI68PFJ9AvREPWcenNIOKhXSHK29gZ9C8EscHYTZGyZIfGtAKwnnSuJV3x89uEZbajqpbnNpEftgT_argGQNxKhgU1QkQtsK0Pqpk8G5UfU-iFcQkX_wEZqTTsFwz0dDUcgUwjCtZgvoIUshfZVFxlvBLf64es7jdvGvTTlUhX7sUMku1A-gy5SiMVnFyW_MIb1TZVlF7b5bHQ
}

Request Example

Request URL

https://paperdb.io/api/GetArchtype

Server Response

Response Body

                                        
{
 "data": [
    {
     "id": 3,
     "name": "Coated"
    },
    {
     "id": 5,
     "name": "Offset"
    },
    {
     "id": 8,
     "name": "Uncoated"
    },
 ]
}

GET //paperdb.io/api/GetSuppliers

Request-Headers:

                                    
{
Accept: application/json
Content-Type: application/json
Authorization :Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImRlOGZlMzQxNzAxNTRiYWQwN2Q3ZDQxOGQwNzMwMDU5ODNhMGFhNzE5MzFlNjIwOWQ1MDdiMjY2MTI0YjM3NzIzOTMyZmU2MWZlODhkNDg2In0.eyJhdWQiOiIxIiwianRpIjoiZGU4ZmUzNDE3MDE1NGJhZDA3ZDdkNDE4ZDA3MzAwNTk4M2EwYWE3MTkzMWU2MjA5ZDUwN2IyNjYxMjRiMzc3MjM5MzJmZTYxZmU4OGQ0ODYiLCJpYXQiOjE1MjU3NTM3MTYsImf909CYxFKIBPnLwE4JnGEwXGdtVf7Q-i8PdmK2m0czOov1-Wzwayl7qo828Equr2sfmgky4Q4vI-Ffet_yobZv60XqAxAn7Jm1_V4NGe3w6Smi0DSjpgEnkS5e4ERdWlI68PFJ9AvREPWcenNIOKhXSHK29gZ9C8EscHYTZGyZIfGtAKwnnSuJV3x89uEZbajqpbnNpEftgT_argGQNxKhgU1QkQtsK0Pqpk8G5UfU-iFcQkX_wEZqTTsFwz0dDUcgUwjCtZgvoIUshfZVFxlvBLf64es7jdvGvTTlUhX7sUMku1A-gy5SiMVnFyW_MIb1TZVlF7b5bHQ
}

Request Example

Request URL

https://paperdb.io/api/GetSuppliers

Server Response

Response Body

                                        
{
 "data": [
    {
     "id": 13,
     "name": "Antalis"
    },
    {
     "id": 15,
     "name": "Finchpaper"
    },
    {
     "id": 18,
     "name": "Papyrus"
    },
 ]
}

POST //paperdb.io/api/ListPapersByQuery

Request-Headers:

                                    
{
Accept: application/json
Content-Type: application/json
Authorization :Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImRlOGZlMzQxNzAxNTRiYWQwN2Q3ZDQxOGQwNzMwMDU5ODNhMGFhNzE5MzFlNjIwOWQ1MDdiMjY2MTI0YjM3NzIzOTMyZmU2MWZlODhkNDg2In0.eyJhdWQiOiIxIiwianRpIjoiZGU4ZmUzNDE3MDE1NGJhZDA3ZDdkNDE4ZDA3MzAwNTk4M2EwYWE3MTkzMWU2MjA5ZDUwN2IyNjYxMjRiMzc3MjM5MzJmZTYxZmU4OGQ0ODYiLCJpYXQiOjE1MjU3NTM3MTYsImf909CYxFKIBPnLwE4JnGEwXGdtVf7Q-i8PdmK2m0czOov1-Wzwayl7qo828Equr2sfmgky4Q4vI-Ffet_yobZv60XqAxAn7Jm1_V4NGe3w6Smi0DSjpgEnkS5e4ERdWlI68PFJ9AvREPWcenNIOKhXSHK29gZ9C8EscHYTZGyZIfGtAKwnnSuJV3x89uEZbajqpbnNpEftgT_argGQNxKhgU1QkQtsK0Pqpk8G5UfU-iFcQkX_wEZqTTsFwz0dDUcgUwjCtZgvoIUshfZVFxlvBLf64es7jdvGvTTlUhX7sUMku1A-gy5SiMVnFyW_MIb1TZVlF7b5bHQ
}

Parameters

Input
OrderBy String Optional
Page Int Optional
PageSize Int Optional,(Max:100)
Query [Object(JSON)] Optional 
                                    
{
 "query":
 {
    archtype:[
    {
        "value":"Uncoated",
        "operator":"lk"
    }],
    grammage:[
    {
        "value":"100",
        "operator":"gte"
    },
    {
        "value":"150",
        "operator":"lte"
    }]
},
 "orderBy":
    {
        "fieldName":"id",
        "type":"DESC"
    },
     "pageSize":"5",
     "page":"1"
}

Request Example

Request URL

https://paperdb.io/api/ListPapersByQuery

Server Response

Response Body

                                        
{
 "data": [
    {
     "id": 9696,
     "name": "White bond paper 110(g/m2)"
    },
    {
     "id": 9695,
     "name": "Cream Bond Paper light yellowish  110(g/m2)"
    },
 ],
 "meta": {
     "CurrentPage": 1,
     "PageSize": 5,
     "TotalPages": 23,
     "TotalCnt": 112
    }
}

GET //paperdb.io/api/GetPaperById

Request-Headers:

                                    
{
Accept: application/json
Content-Type: application/json
Authorization :Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImRlOGZlMzQxNzAxNTRiYWQwN2Q3ZDQxOGQwNzMwMDU5ODNhMGFhNzE5MzFlNjIwOWQ1MDdiMjY2MTI0YjM3NzIzOTMyZmU2MWZlODhkNDg2In0.eyJhdWQiOiIxIiwianRpIjoiZGU4ZmUzNDE3MDE1NGJhZDA3ZDdkNDE4ZDA3MzAwNTk4M2EwYWE3MTkzMWU2MjA5ZDUwN2IyNjYxMjRiMzc3MjM5MzJmZTYxZmU4OGQ0ODYiLCJpYXQiOjE1MjU3NTM3MTYsImf909CYxFKIBPnLwE4JnGEwXGdtVf7Q-i8PdmK2m0czOov1-Wzwayl7qo828Equr2sfmgky4Q4vI-Ffet_yobZv60XqAxAn7Jm1_V4NGe3w6Smi0DSjpgEnkS5e4ERdWlI68PFJ9AvREPWcenNIOKhXSHK29gZ9C8EscHYTZGyZIfGtAKwnnSuJV3x89uEZbajqpbnNpEftgT_argGQNxKhgU1QkQtsK0Pqpk8G5UfU-iFcQkX_wEZqTTsFwz0dDUcgUwjCtZgvoIUshfZVFxlvBLf64es7jdvGvTTlUhX7sUMku1A-gy5SiMVnFyW_MIb1TZVlF7b5bHQ
}

Parameters

Input
Id Int Mandatory

Request Example

Request URL

https://paperdb.io/api/GetPaperById?id=5060

Server Response

Response Body

                                        
{
 "data": [
    {
     "id": 5060,
     "brand_id": 1120,
     "brand_name": "Metsäboard Natural Wkl Bright",
     "archtype": "Uncoated",
     "mill": "",
     "traceable_source": "",
     "recycled_resource": "",
     "prepared_for_hp_digital": "",
     "sheet_web": "Yes",
     "us_weight_group": "",
     "us_weight": "",
     "grammage": 100,
     "opacity": 0,
     "thickness": 125,
     "bulk_thickness": 0,
     "whiteness": 103,
     "surface": 240,
     "gloss": "",
     "screen_from": "",
     "screen_to": "",
     "permanent_document": "",
     "laminated_paper": "",
     "ce_coated": "",
     "sheffield": "",
     "ppi": "",
     "windpower": "",
     "link_to_pdf": "https://www.metsaboard.com/MaterialArchive/Paper-profiles/Product-paper-profile-MetsaBoard-Natural-WKL-Bright.pdf",
     "link_to_paper": "https://www.metsaboard.com/Customers/White-kraftliners/Product-MetsaBoard-Natural-WKL-Bright/Pages/default.aspx",
     "brightness": 86,
     "other_link_to_product": "",
     "merchant": "",
    },
 ]
}