Skilvul Public API (1.0.0)

Access Tokens

To retrieve an access token, POST a clientId/clientSecret combination to /v1/oauth/token.

For example:

curl -X POST 'https://public.api.skilvul.com/v1/oauth/token' -d "clientId=YOUR_CLIENT_ID&clientSecret=YOUR_CLIENT_SECRET"

returns a response like:

{
    "tokenType": "Bearer",
    "accessToken": "aa9f3cdb7c5359d3621e58ee59c7feb31ec03da818d9a8dd939f3a8eff15e140",
    "accessTokenExpiresAt": 1587448713231,
    "refreshToken": "3fd78bb5eb4ce238701e16309e0c6f7d15d2b09bab40d3a7dd2eb4dd74d3dffr",
    "refreshTokenExpiresAt": 1587448713231,
    "error": null
}

Token Expiration

Access tokens will expire, if an expired token is used a 403 status code will be returned. The refresh token can be used to automatically renew an access token without requiring the password again (as long as the refresh token used is also not yet expired).

For example:

curl -X POST 'https://public.api.skilvul.com/v1/oauth/token/refresh' -d "clientId=YOUR_CLIENT_ID&refreshToken=YOUR_REFRESH_TOKEN"

If the refresh token has expired, you will need to generate a new one using /v1/oauth/token.

Authentication

Authenticate requests by including an Authorization header of type Bearer.

For example:

curl 'https://public.api.skilvul.com/v1/products' -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

/v1/oauth

Request new access/refresh tokens

Request Body schema: application/json
required

clientId required	string The Client ID provided by Skilvul.
clientSecret required	string The Client Secret provided by Skilvul.

Responses

Request samples

Payload

Content type

application/json

{"clientId": "YOUR_CLIENT_ID",
"clientSecret": "YOUR_CLIENT_SECRET"
}

Response samples

200
400
403
404
500

Content type

application/json

{"tokenType": "Bearer",
"accessToken": "aa9f3cdb7c5359d3621e58ee59c7feb31ec03da818d9a8dd939f3a8eff15e140",
"accessTokenExpiresAt": 1587448713231,
"refreshToken": "3fd78bb5eb4ce238701e16309e0c6f7d15d2b09bab40d3a7dd2eb4dd74d3dffr",
"refreshTokenExpiresAt": 1587967113231,
"error": null
}

Renew access token

Request Body schema: application/json
required

clientId required	string The Client ID provided by Skilvul.
refreshToken required	string The refresh token generated from `/v1/oauth/token`.

Responses

Request samples

Payload

Content type

application/json

{"clientId": "YOUR_CLIENT_ID",
"refreshToken": "YOUR_REFRESH_TOKEN"
}

Response samples

200
400
403
404
500

Content type

application/json

{"tokenType": "Bearer",
"accessToken": "aa9f3cdb7c5359d3621e58ee59c7feb31ec03da818d9a8dd939f3a8eff15e140",
"accessTokenExpiresAt": 1587448713231,
"error": null
}

/v1/bundles

Get a list of Bundles

Authorizations:

bearerAuth

query Parameters

limit	integer Default: 10
offset	integer

Responses

Response samples

200
500

Content type

application/json

{"bundles": [{"id": "ck108q0se017c9c824jwo4hid",
"title": "Bundle ABC",
"shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"fullDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/bundle/FwqK3W86sKns3jn-3qmN3.jpg",
"url": "https://www.skilvul.com/bundles/ck108q0se017c0715zfh68162",
"price": 60000,
"products": null,
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
}
],
"totalBundles": 1,
"error": null
}

Get total Bundle count

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"count": 1,
"error": null
}

Get a single Bundle

Authorizations:

bearerAuth

path Parameters

bundleId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"bundle": {"id": "ck108q0se017c9c824jwo4hid",
"title": "Bundle ABC",
"shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"fullDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/bundle/FwqK3W86sKns3jn-3qmN3.jpg",
"url": "https://www.skilvul.com/bundles/ck108q0se017c0715zfh68162",
"price": 60000,
"products": null,
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
},
"error": null
}

Check whether or not a User has Purchased a Bundle

Authorizations:

bearerAuth

path Parameters

bundleId

required

string

query Parameters

email

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"canBuy": true,
"error": null
}

/v1/products

Get a list of Products

Authorizations:

bearerAuth

query Parameters

limit	integer Default: 10
offset	integer

Responses

Response samples

200
500

Content type

application/json

{"products": [{"id": "ck108q0se017c0715zfh68162",
"title": "Kelas ABC",
"shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"fullDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.",
"type": "PATH",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/course/FwqK3W86sKns3jn-3qmN3.jpg",
"url": "https://www.skilvul.com/courses/ck108q0se017c0715zfh68162",
"price": 60000,
"requiredCourses": null,
"lessons": [{"order": 1,
"title": "ABC"
}
],
"addOns": [{"id": "ck108q0se017c07031293kd09",
"title": "Kelas ABC",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"type": "BADGE",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/course/FwqK3W86sKns3jn-3qmN3.jpg",
"price": 25000,
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
}
],
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
}
],
"totalProducts": 1,
"error": null
}

Get total Product count

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"count": 1,
"error": null
}

Get a single Product

Authorizations:

bearerAuth

path Parameters

productId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"product": {"id": "ck108q0se017c0715zfh68162",
"title": "Kelas ABC",
"shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"fullDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.",
"type": "PATH",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/course/FwqK3W86sKns3jn-3qmN3.jpg",
"url": "https://www.skilvul.com/courses/ck108q0se017c0715zfh68162",
"price": 60000,
"requiredCourses": null,
"lessons": [{"order": 1,
"title": "ABC"
}
],
"addOns": [{"id": "ck108q0se017c07031293kd09",
"title": "Kelas ABC",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"type": "BADGE",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/course/FwqK3W86sKns3jn-3qmN3.jpg",
"price": 25000,
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
}
],
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
},
"error": null
}

Check whether or not a User has Purchased a Product

Authorizations:

bearerAuth

path Parameters

productId

required

string

query Parameters

email

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"canBuy": true,
"error": null
}

/v1/addons

Get a single Add-on

Authorizations:

bearerAuth

path Parameters

addOnId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"addOn": {"id": "ck108q0se017c07031293kd09",
"title": "Kelas ABC",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"type": "BADGE",
"imageUrl": "https://skilvul-prod.s3.ap-southeast-1.amazonaws.com/course/FwqK3W86sKns3jn-3qmN3.jpg",
"price": 25000,
"lastUpdatedAt": "2020-04-29T16:56:16.158Z"
},
"error": null
}

Check whether or not a User has Purchased a Add-on

Authorizations:

bearerAuth

path Parameters

addOnId

required

string

query Parameters

email

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"canBuy": true,
"error": null
}

/v1/orders

Create a new Order

Authorizations:

bearerAuth

Request Body schema: application/json
required

required	object
bundleIds	Array of strings List of Bundle Ids to be purchased.
productIds	Array of strings List of Product Ids to be purchased.
addOnIds	Array of strings List of Add-on Ids to be purchased.

Responses

Request samples

Payload

Content type

application/json

{"user": {"email": "jon.snow@winterfell.com",
"firstName": "Jon",
"lastName": "Snow",
"gender": "MALE"
},
"bundleIds": ["ck108q0se017c9c824jwo4hid"
],
"productIds": ["ck108q0se017c0715zfh68162"
],
"addOnIds": ["ck108q0se017c07031293kd09"
]
}

Response samples

200
400
404
500

Content type

application/json

{"user": {"id": "ck91czrpilaob001826psge4st",
"email": "jon.snow@winterfell.com"
},
"order": {"id": "string",
"items": [{"id": "ck108q0se017c9c824jwo4hid",
"title": "Bundle ABC",
"price": 60000,
"type": "BUNDLE"
},
{"id": "ck108q0se017c0715zfh68162",
"title": "Kelas ABC",
"price": 60000,
"type": "PRODUCT"
},
{"id": "ck108q0se017c07031293kd09",
"title": "Kelas ABC",
"price": 25000,
"type": "ADDON",
"addOnType": "BADGE"
}
],
"totalAmount": 145000,
"totalPayment": 0,
"status": "COMPLETED",
"createdAt": "2020-04-21T03:17:03.568Z"
},
"orderSuccessUrl": "https://skilvul.com/uoc?t=9af6548240219d4058f1f558bdec86429accb18b73d3cc2ef09d729736e",
"error": null,
"errorBundleIds": [ ],
"errorProductIds": [ ],
"errorAddOnIds": [ ]
}

Validate Order

Authorizations:

bearerAuth

Request Body schema: application/json
required

required	object
bundleIds	Array of strings List of Bundle Ids to be purchased.
productIds	Array of strings List of Product Ids to be purchased.
addOnIds	Array of strings List of Add-on Ids to be purchased.

Responses

Request samples

Payload

Content type

application/json

{"user": {"email": "jon.snow@winterfell.com",
"firstName": "Jon",
"lastName": "Snow",
"gender": "MALE"
},
"bundleIds": ["ck108q0se017c9c824jwo4hid"
],
"productIds": ["ck108q0se017c0715zfh68162"
],
"addOnIds": ["ck108q0se017c07031293kd09"
]
}

Response samples

200
400
404
500

Content type

application/json

{"user": {"id": "ck91czrpilaob001826psge4st",
"email": "jon.snow@winterfell.com"
},
"error": null,
"errorBundleIds": [ ],
"errorProductIds": [ ],
"errorAddOnIds": [ ]
}

/v1/provinces

Get a list of Provinces

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"provinces": [{"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
}
],
"totalProvinces": 1,
"error": null
}

Get a single Province

Authorizations:

bearerAuth

path Parameters

provinceId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"province": {"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
},
"error": null
}

/v1/cities

Get a list of Cities

Authorizations:

bearerAuth

query Parameters

provinceId

required

string

Responses

Response samples

200
500

Content type

application/json

{"cities": [{"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
}
],
"totalCities": 1,
"error": null
}

Get a single City

Authorizations:

bearerAuth

path Parameters

cityId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"city": {"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
},
"error": null
}

/v1/professions

Get a list of Professions

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"professions": ["Pelajar (SMP)"
],
"totalProfessions": 1,
"error": null
}

/v1/schools

Get a list of School Grades

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"schoolGrades": [{"id": "ck108q0se017c0715zfh68162",
"grade": "SD"
}
],
"totalSchoolGrades": 1,
"error": null
}

Get a list of School Types

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"schoolTypes": [{"id": "ck108q0se017c0715zfh68162",
"type": "Swasta"
}
],
"totalSchoolTypes": 1,
"error": null
}

Get a list of Schools

Authorizations:

bearerAuth

query Parameters

schoolGradeId required	string
schoolTypeId	string
provinceId required	string
cityId	string
search	string

Responses

Response samples

200
400
500

Content type

application/json

{"schools": [{"id": "ck108q0se017c0715zfh68162",
"name": "SD IT INSAN MADANI MEUKEK"
}
],
"totalSchools": 1,
"error": null
}

/v1/users

Get a single User

Authorizations:

bearerAuth

path Parameters

userId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"user": {"id": "ck108q0se017c0715zfh68162",
"email": "john@mail.com",
"firstName": "John",
"lastName": "Doe",
"isEmailVerified": false,
"totalSkilPoin": 0,
"skilBadge": [{"id": "ck108q0se017c0715zfh68162",
"name": "Web Development Pemula (Gold)",
"pictureUrl": "https://media.badgr.com/uploads/badges/97e286ff-41cb-4128-adcc-1f2fe6525342.svg",
"openBadgeId": "d0l5r05nTZWetl98ijoXUQ",
"badgrUrl": "https://badgr.com/public/assertions/d0l5r05nTZWetl98ijoXUQ?identity__email=john@mail.com",
"certificateUrl": "https://skilvul.com/paths/web-development-pemula/student/ck108q0se0109m715zfc34962"
}
],
"totalSkilBadge": 1,
"totalCourse": 1,
"totalCompletedCourse": 1,
"totalPath": 1,
"totalCompletedPath": 1,
"gender": "MALE",
"birthPlace": "Indonesia",
"birthDate": "2020-11-10T00:00:00.000Z",
"province": {"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
},
"city": {"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
},
"profession": "Pelajar (SMP)",
"phone": 82111111111,
"address": "Jl. Apel 1",
"zipCode": "12345",
"pictureUrl": "string",
"school": {"id": "ck108q0se017c0715zfh68162",
"name": "SD IT INSAN MADANI MEUKEK",
"grade": {"id": "ck108q0se017c0715zfh68162",
"grade": "SD"
},
"type": {"id": "ck108q0se017c0715zfh68162",
"type": "Swasta"
},
"province": {"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
},
"city": {"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
}
},
"otherSchool": { }
},
"error": null
}

Update a User

Authorizations:

bearerAuth

path Parameters

userId

required

string

Request Body schema: application/json
required

firstName	string
lastName	string
gender	string Enum: "MALE" "FEMALE" "NOT_SPECIFIED"
birthPlace	string
birthDate	string
provinceId	string Required if `cityId` is not null.
cityId	string Required if `provinceId` is not null.
profession	string
schoolId	string
otherSchoolName	string or null Value: null If `schoolId` is not null, `otherSchoolName` will be ignored
schoolGradeId	string Required if `schoolId` or `otherSchoolName` is not null.
schoolTypeId	string
schoolProvinceId	string Required if `schoolId` or `otherSchoolName` is not null.
schoolCityId	string

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Doe",
"gender": "MALE",
"birthPlace": "Indonesia",
"birthDate": "2020-11-10T00:00:00.000Z",
"provinceId": "ck108q0se017c0715zfh68162",
"cityId": "ck108q0se017c0715zfh68162",
"profession": "Pelajar (SMP)",
"schoolId": "ck108q0se017c0715zfh68162",
"otherSchoolName": null,
"schoolGradeId": "ck108q0se017c0715zfh68162",
"schoolTypeId": "ck108q0se017c0715zfh68162",
"schoolProvinceId": "ck108q0se017c0715zfh68162",
"schoolCityId": "ck108q0se017c0715zfh68162"
}

Response samples

200
400
404
500

Content type

application/json

{"user": {"id": "ck108q0se017c0715zfh68162",
"email": "john@mail.com",
"firstName": "John",
"lastName": "Doe",
"isEmailVerified": false,
"totalSkilPoin": 0,
"skilBadge": [{"id": "ck108q0se017c0715zfh68162",
"name": "Web Development Pemula (Gold)",
"pictureUrl": "https://media.badgr.com/uploads/badges/97e286ff-41cb-4128-adcc-1f2fe6525342.svg",
"openBadgeId": "d0l5r05nTZWetl98ijoXUQ",
"badgrUrl": "https://badgr.com/public/assertions/d0l5r05nTZWetl98ijoXUQ?identity__email=john@mail.com",
"certificateUrl": "https://skilvul.com/paths/web-development-pemula/student/ck108q0se0109m715zfc34962"
}
],
"totalSkilBadge": 1,
"totalCourse": 1,
"totalCompletedCourse": 1,
"totalPath": 1,
"totalCompletedPath": 1,
"gender": "MALE",
"birthPlace": "Indonesia",
"birthDate": "2020-11-10T00:00:00.000Z",
"province": {"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
},
"city": {"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
},
"profession": "Pelajar (SMP)",
"phone": 82111111111,
"address": "Jl. Apel 1",
"zipCode": "12345",
"pictureUrl": "string",
"school": {"id": "ck108q0se017c0715zfh68162",
"name": "SD IT INSAN MADANI MEUKEK",
"grade": {"id": "ck108q0se017c0715zfh68162",
"grade": "SD"
},
"type": {"id": "ck108q0se017c0715zfh68162",
"type": "Swasta"
},
"province": {"id": "ck108q0se017c0715zfh68162",
"name": "Aceh"
},
"city": {"id": "ck108q0se017c0715zfh68162",
"name": "Kab. Aceh Selatan"
}
},
"otherSchool": { }
},
"error": null
}

Resend email verification to User

Authorizations:

bearerAuth

path Parameters

userId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"success": true,
"error": null
}

Logout User

Authorizations:

bearerAuth

path Parameters

userId

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"error": null
}

Skilvul Public API (1.0.0)

Access Tokens

Token Expiration

Authentication

/v1/oauth

Request new access/refresh tokens

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Renew access token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/v1/bundles

Get a list of Bundles

Authorizations:

query Parameters

Responses

Response samples

Get total Bundle count

Authorizations:

Responses

Response samples

Get a single Bundle

Authorizations:

path Parameters

Responses

Response samples

Check whether or not a User has Purchased a Bundle

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/v1/products

Get a list of Products

Authorizations:

query Parameters

Responses

Response samples

Get total Product count

Authorizations:

Responses

Response samples

Get a single Product

Authorizations:

path Parameters

Responses

Response samples

Check whether or not a User has Purchased a Product

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/v1/addons

Get a single Add-on

Authorizations:

path Parameters

Responses

Response samples

Check whether or not a User has Purchased a Add-on

Authorizations:

path Parameters

query Parameters

Responses

Response samples

/v1/orders

Create a new Order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate Order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required