Public Product API Endpoints
Authorizations
Query parameters
pageinteger | nullableOptionalExample:
Page of the index to retrieve
1
per_pageinteger | nullableOptionalExample:
Number of Products per page to retrieve for the index
20
search_termsstring[] | nullableOptionalExample:
Array of search terms for filtering the Products to retrieve in the index
test
tag_filtersstring[] | nullableOptionalExample:
Array of tags to filter the Products to retrieve in the index
LTI11
Responses
200
get success: Product Collection
application/json
401
Unauthorized
get
GET /learnplatform/public-products/api/public/v1/products HTTP/1.1
Host: api-gateway.instructure.com
Authorization: Bearer JWT
Accept: */*
{
"products": [
{
"id": 1777,
"name": "Name 1",
"tagline": "Name 2",
"url": "kassulke-hansen.test/luise_will",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1706,
"name": "string-12",
"company_url": "http://site-3.test"
},
"company_name": "string-12",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1778,
"name": "Name 4",
"tagline": "Name 5",
"url": "sauer-mosciski.example/verline.johnson",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1706,
"name": "string-12",
"company_url": "http://site-3.test"
},
"company_name": "string-12",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1779,
"name": "Name 7",
"tagline": "Name 8",
"url": "howe.example/antonia",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1706,
"name": "string-12",
"company_url": "http://site-3.test"
},
"company_name": "string-12",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1780,
"name": "Name 10",
"tagline": "Name 11",
"url": "dubuque.example/modesta.schamberger",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1706,
"name": "string-12",
"company_url": "http://site-3.test"
},
"company_name": "string-12",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1781,
"name": "Name 13",
"tagline": "Name 14",
"url": "yost.test/clyde_bruen",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1706,
"name": "string-12",
"company_url": "http://site-3.test"
},
"company_name": "string-12",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
}
],
"meta": {
"count": 5,
"total_count": 5,
"current_page": 1,
"num_pages": 1,
"per_page": 20
}
}
Authorizations
Query parameters
pageinteger | nullableOptionalExample:
Page of the index to retrieve
1
per_pageinteger | nullableOptionalExample:
Number of Products per page to retrieve for the index
20
search_termsstring[] | nullableOptionalExample:
Array of search terms for filtering the Products to retrieve in the index
test
tag_filtersstring[] | nullableOptionalExample:
Array of tags to filter the Products to retrieve in the index
LTI11
Responses
200
post success: Product Collection
application/json
401
Unauthorized
post
POST /learnplatform/public-products/api/public/v1/products HTTP/1.1
Host: api-gateway.instructure.com
Authorization: Bearer JWT
Accept: */*
{
"products": [
{
"id": 1787,
"name": "Name 31",
"tagline": "Name 32",
"url": "larson.test/kristian",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1708,
"name": "string-60",
"company_url": "http://site-9.test"
},
"company_name": "string-60",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1788,
"name": "Name 34",
"tagline": "Name 35",
"url": "beer.example/luke",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1708,
"name": "string-60",
"company_url": "http://site-9.test"
},
"company_name": "string-60",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1789,
"name": "Name 37",
"tagline": "Name 38",
"url": "glover.example/athena",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1708,
"name": "string-60",
"company_url": "http://site-9.test"
},
"company_name": "string-60",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1790,
"name": "Name 40",
"tagline": "Name 41",
"url": "langosh.test/tommy",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1708,
"name": "string-60",
"company_url": "http://site-9.test"
},
"company_name": "string-60",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
},
{
"id": 1791,
"name": "Name 43",
"tagline": "Name 44",
"url": "sanford-gutmann.example/elinore.rowe",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1708,
"name": "string-60",
"company_url": "http://site-9.test"
},
"company_name": "string-60",
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png"
}
],
"meta": {
"count": 5,
"total_count": 5,
"current_page": 1,
"num_pages": 1,
"per_page": 20
}
}
Authorizations
Path parameters
idinteger · min: 1RequiredExample:
ID of the Product to retrieve
1
Responses
200
Details for the Product
application/json
401
Unauthorized
404
Product not found
get
GET /learnplatform/public-products/api/public/v1/products/{id} HTTP/1.1
Host: api-gateway.instructure.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1797,
"name": "Name 61",
"description": "Name 63",
"tagline": "Name 62",
"url": "halvorson.example/mariano",
"logo_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"logo_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"company": {
"id": 1710,
"name": "string-110",
"company_url": "http://site-15.test"
},
"company_name": "string-110",
"company_url": "http://site-15.test",
"screenshot_image_urls": [
"https://assets.learnplatform.com/assets/screenshot.png",
"https://assets.learnplatform.com/assets/screenshot.png",
"https://assets.learnplatform.com/assets/screenshot.png"
],
"banner_image_url": "https://assets.learnplatform.com/assets/cat_badge.png",
"support_url": null,
"accessibility_url": "http://fadel-grimes.example/luis",
"privacy_policy_url": "http://rice.example/senaida",
"terms_of_service_url": "http://wolf.test/tamiko.prohaska",
"badges": [],
"lti_configurations": {
"lti_13": {
"services": [
"est"
],
"placements": [
"sit"
]
}
},
"accepting_leads": false,
"video": "http://tremblay.example/novella"
}
Body
countrystringRequiredExample:
US
statestringRequiredExample:
AR
organizationstringRequiredExample:
Lawrence Public School District
current_canvas_companyboolean | nullableOptionalExample:
true
gradestring · enum | nullableOptionalExample:
K12
Possible values: namestringRequiredExample:
Anne Example
rolestringRequiredExample:
C&I Director
emailstring · emailRequiredExample:
[email protected]
notesstring | nullableOptionalExample:
Please detail any specific information you would like to learn from this partner.
tool_idintegerRequiredExample:
123
Responses
201
post success: User details saved when state is empty
application/json
422
Not accepting leads: Unprocessable Entity
application/json
post
POST /learnplatform/public-products/api/public/v1/learn_more HTTP/1.1
Host: api-gateway.instructure.com
Content-Type: application/json
Accept: */*
Content-Length: 304
{
"country": "US",
"state": "AR",
"organization": "Lawrence Public School District",
"current_canvas_company": true,
"grade": "K12",
"name": "Anne Example",
"role": "C&I Director",
"email": "[email protected]",
"notes": "Please detail any specific information you would like to learn from this partner.",
"tool_id": 123
}
{
"message": "Thank you for your interest in learning more about Sample Tool Name!"
}
Last updated
Was this helpful?