API

Docs and API's for Weasy.io

URL forwarding

Manage all the url forwarding in your website.

Accepts GET POST PUT DELETE

All requests to the API must be authenticated with an API key on the HTTP Authorization header.

GET

Get all files from website filemanager

GET/urlforwarding{?limit,page}

Request example

~ curl -i -X GET \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
https://api.weasy.io/v1/urlforwarding



Body response example [ HTTP CODE: 200 ]

{  
   "items":[  
      {  
         "id":"1",
         "source":"https://weasy.io/product/sample",
         "type":"302",
         "destination":"https://weasy.io/product/newsample"
      },
      {  
         "id":"2",
         "source":"https://weasy.io/product/sample2",
         "type":"302",
         "destination":"https://weasy.io/product/newsample2"
      }
      ...
   ],
   "paging":{  
      "total":"100",
      "totalpages":4,
      "previous":"https://api.weasy.io/v1/urlforwarding?limit=25&page=1",
      "next":"https://api.weasy.io/v1/urlforwarding?limit=25&page=3"
   }
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
limit integer optional define items per page
page integer optional define page to display


POST

Add a url forward or collection of url forwards to your website.


POST/urlforward

Request example

~ curl -i -X POST \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '[{"source":"http://www.weasy.io/products/sample","type":302,"destination":"http://www.weasy.io/products/sample2"},\
{"source":"http://www.weasy.io/products/sample3","type":301,"destination":"http://www.weasy.io/products/sample4"}]'\
https://api.weasy.io/v1/urlforward



Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "source":"http://www.weasy.io/products/sample3",
      "id":8
   },
   {  
      "status":"error",
      "source":"http://www.weasy.io/products/sample"
   }
]



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
source string required source url to be redirected
type integer required redirect type
options:
301 for permanent, 302 for temporary redirect
destination string required destination to the new url


PUT

Change a url forward from your website.


PUT/urlforward/:id

Request example

~ curl -i -X PUT \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '{"source":"http://www.weasy.io/products/sample","type":302,"destination":"http://www.weasy.io/products/sample3"}'\
https://api.weasy.io/v1/urlforward/1



Body response example [ HTTP CODE: 200 ]

{  
   "status":"ok"
}
or
{  
   "status":"error"
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
id integer required url forward id



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
source string required source url to be redirected
type integer required redirect type
options:
301 for permanent, 302 for temporary redirect
destination string required destination to the new url


DELETE

Delete a url forward or collection of url forwards from your website.


DELETE/urlforward

Request example

~ curl -i -X DELETE \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '[1,2]'\
https://api.weasy.io/v1/newsletter



Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "id":1
   },
   {  
      "status":"error",
      "id":2
   }
]



Body attributes

Attribute description
A json payload containing an array of id or ids.
Use GET for collect all the ids.