Utils

Last updated: 14 May 2024

Making requests with Http #

The Canvas SDK offers a helper class for completing HTTP calls.

from canvas_sdk.utils import Http
http = Http()

get #

Sends a GET request.

Parameters:

Name	Type	Required	Description
url	string	true	The url of the request.
headers	dict	false	The headers to include in the request.

Example:

http = Http()
http.get("https://my-url.com/", headers={"Authorization": f"Bearer token"})

post #

Sends a POST request.

Parameters:

Name	Type	Required	Description
url	string	true	The url of the request.
headers	dict	false	The headers to include in the request.
json	dict	false	The json to include in the request.
data	dict or string	false	The data to include in the request.

Example:

http = Http()
http.post(
    "https://my-url.com/",
    headers={"Authorization": f"Bearer token"},
    json={"post": "json"},
    data="this-is-my-data"
)

put #

Sends a PUT request.

Parameters:

Name	Type	Required	Description
url	string	true	The url of the request.
headers	dict	false	The headers to include in the request.
json	dict	false	The json to include in the request.
data	dict or string	false	The data to include in the request.

Example:

http = Http()
http.put(
    "https://my-url.com/",
    headers={"Authorization": f"Bearer token"},
    json={"put": "json"},
    data="this-is-my-data"
)

patch #

Sends a PATCH request.

Parameters:

Name	Type	Required	Description
url	string	true	The url of the request.
headers	dict	false	The headers to include in the request.
json	dict	false	The json to include in the request.
data	dict or string	false	The data to include in the request.

Example:

http = Http()
http.patch(
    "https://my-url.com/",
    headers={"Authorization": f"Bearer token"},
    json={"patch": "json"},
    data="this-is-my-data"
)