This documentation explains how to use Mykoob API.
\nlogin_url - https://login.mykoob.dev
api_url - https://api.mykoob.dev
login_url - https://login.mykoob.lv
api_url - https://api.mykoob.lv
When making a request, the user's browser will be redirected to the Mykoob authorization service, where the user must log in and grant the right to access their profile. After successful confirmation, the browser will be redirected to the specified redirect link with the added user authorization code required in step 2.
\n","urlObject":{"path":["oauth","authorize"],"host":["{{login_url}}"],"query":[{"description":{"content":"must place the previously granted client application identifier
\n","type":"text/plain"},"key":"client_id","value":null},{"description":{"content":"must place the previously granted redirect uri
\n","type":"text/plain"},"key":"redirect_uri","value":null},{"description":{"content":"must place “code”
\n","type":"text/plain"},"key":"response_type","value":"code"},{"description":{"content":"must place the previously granted client scope, for example, “view-user”
\n","type":"text/plain"},"key":"scope","value":null}],"variable":[]}},"response":[{"id":"70457981-1605-45fe-b808-80e1d2c7e95b","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{login_url}}/oauth/authorize?client_id&redirect_uri&response_type=code&scope","host":["{{login_url}}"],"path":["oauth","authorize"],"query":[{"key":"client_id","value":null,"description":"must place the previously granted client application identifier"},{"key":"redirect_uri","value":null,"description":"must place the previously granted redirect uri"},{"key":"response_type","value":"code","description":"must place “code”"},{"key":"scope","value":null,"description":"must place the previously granted client scope, for example, “view-user”"}]}},"status":"Found","code":302,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{redirect_uri}?code={code}"},{"id":"735cdcee-587c-4285-a952-cd49d78fec32","name":"Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{login_url}}/oauth/authorize?client_id&redirect_uri&response_type=code&scope","host":["{{login_url}}"],"path":["oauth","authorize"],"query":[{"key":"client_id","value":null,"description":"must place the previously granted client application identifier"},{"key":"redirect_uri","value":null,"description":"must place the previously granted redirect uri"},{"key":"response_type","value":"code","description":"must place “code”"},{"key":"scope","value":null,"description":"must place the previously granted client scope, for example, “view-user”"}]}},"status":"Found","code":302,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{redirect_uri}?error={error name}&message={error message}&hint={error hint}"}],"_postman_id":"cefda122-9d07-4512-b17c-4da96b6f72bc"},{"name":"Authorization code exchange","id":"086bf6f0-1ebc-496c-88e3-e9cf4ac5f59a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"must place “authorization_code”
\n","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier
\n","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret
\n","type":"text"},{"key":"redirect_uri","value":"","description":"must place the previously granted redirect uri
\n","type":"text"},{"key":"code","value":"","description":"must place the “code”, which was obtained in step 1
\n","type":"text"}]},"url":"{{login_url}}/oauth/token","description":"After receiving \"access_token\", the user has granted the rights to access his Mykoob profile information. With this access token, we can access API features using the API authorization.
\nIf the user's “refresh_token” is valid, it is possible to renew the user's access token without requesting new “code”. This way, the user will not have to log in to the eKool system to be authorized against the app
\n","urlObject":{"path":["oauth","token"],"host":["{{login_url}}"],"query":[],"variable":[]}},"response":[{"id":"3c375352-5b44-4456-b1b8-22fa108223cc","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"must place “authorization_code”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":" redirect_uri","value":"","description":"must place the previously granted redirect uri","type":"text"},{"key":"code","value":"","description":"must place the “code”, which was obtained in step 1","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token_type\": \"Bearer\", // an access token type, which by the oAuth2 standard is “Bearer”\r\n \"expires_in\": 604800, // token expire time in seconds\r\n \"access_token\": \"eyJ0eXiJS1A … UzIi7_A\", // an access token, which is used in API requests, to authorize user\r\n \"refresh_token\": \"def5020c40f … d20b6a62\" // an access renewal token, which is used when access token is expired (step 3)\r\n}\r\n"},{"id":"96f27965-ddc2-4d90-b782-af2f0fcbf543","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","equals":true,"description":"must place “authorization_code”"},{"key":"client_id","value":"","equals":true,"description":"must place the previously granted client application identifier"},{"key":"client_secret","value":"","equals":true,"description":"must place the previously granted client secret"},{"key":" redirect_uri","value":"","equals":true,"description":"must place the previously granted redirect uri"},{"key":"code","value":"","equals":true,"description":"must place the “code”, which was obtained in step 1"}]},"url":"{{login_url}}/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"...\",\r\n \"error_description\": \"...\",\r\n \"hint\": \"...\",\r\n \"message\": \"...\"\r\n}"}],"_postman_id":"086bf6f0-1ebc-496c-88e3-e9cf4ac5f59a"},{"name":"Refresh token","id":"d844c94d-2b72-4032-9456-4e6369348336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”
\n","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier
\n","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret
\n","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2
\n","type":"text"}]},"url":"{{login_url}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{login_url}}"],"query":[],"variable":[]}},"response":[{"id":"97788d90-fbc3-4e91-b56a-3527db7be8cf","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token_type\": \"Bearer\", // an access token type, which by the oAuth2 standard is “Bearer”\r\n \"expires_in\": 604800, // token expire time in seconds\r\n \"access_token\": \"eyJ0eXiJS1A … UzIi7_A\", // an access token, which is used in API requests, to authorize user\r\n \"refresh_token\": \"def5020c40f … d20b6a62\" // an access renewal token, which is used when access token is expired (step 3)\r\n}\r\n"},{"id":"d6754594-fe35-413b-adf5-4f0a463d7631","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"...\",\r\n \"error_description\": \"...\",\r\n \"hint\": \"...\",\r\n \"message\": \"...\"\r\n}"}],"_postman_id":"d844c94d-2b72-4032-9456-4e6369348336"}],"id":"f185d5d7-914c-4603-be58-209c0a1945fd","description":"1. To create a new client, you need to send an email to \"support@mykoob.com\" stating:
\nthe name of the institution or company;
\nname, surname, e-mail and telephone number of the responsible person;
\nthe purpose of authorization usage;
\nredirect uri (for example, https://my.application.com/oauth2/callback ).
\n2. After receiving the authorization data from the e-mail (client application identifier - client_id, associated password - client_secret and available scopes), you can make requests against the Mykoob authorization server - {{login_url}}/oauth/.
\nclient_id consists of 32 numbers and symbols (for example, “oaD43fvd3aCdf45dDsc428hMuY6T6trG”);
\nclient_secret consists of 40 numbers and symbols (for example, “8yFFEvVq65ukVTWtDVRMjttM5nyRg0ErCBJnRSlb”);
\nscopes consists of words or a combination of words denoting data access rights (for example, “view-user”).
\nKeep the client_id, associated secret, and scopes in a safe place. If you have any questions or problems, please contact support@mykoob.com. In case of additional rights, for specific needs, contact the support service by the email above.
\n{{api_url}}/v1/user/personal_id-old
\n{{api_url}}/v1/user/info-old
\n{{api_url}}/v1/user/school_info-old
\n{{api_url}}/v1/user/basic-old
\nIf extra data is needed, please send request with explanation what kind of data is needed and where they would be used to \"support@mykoob.com\"
\n","_postman_id":"f185d5d7-914c-4603-be58-209c0a1945fd"},{"name":"Client authorization","item":[{"name":"Access token","id":"ead8f174-079c-4f44-8c99-66c3b8b7092f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"must place “client_credentials” for client authentication
\n","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier
\n","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret
\n","type":"text"},{"key":"scope","value":"","description":"must place the previously granted client scope, for example, “view-user”
\n","type":"text"}]},"url":"{{login_url}}/oauth/token","description":"To retrieve client's access token, grant type needs to be set to \"client_credentials\" and client ID, secret, scopes must be present. In response there will be access token that can be used to make requests to API server and refresh token to refresh access.
\n","urlObject":{"path":["oauth","token"],"host":["{{login_url}}"],"query":[],"variable":[]}},"response":[{"id":"83e9d552-821f-4c9d-a4d8-c1fbc12eced9","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"must place “client_credentials”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":"scope","value":"","description":"must place the previously granted client scope, for example, “view-user”","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token_type\": \"Bearer\", // an access token type, which by the oAuth2 standard is “Bearer”\r\n \"expires_in\": 604800, // token expire time in seconds\r\n \"access_token\": \"eyJ0eXiJS1A … UzIi7_A\", // an access token, which is used in API requests, to authorize user\r\n \"refresh_token\": \"def5020c40f … d20b6a62\" // an access renewal token, which is used when access token is expired (step 3)\r\n}\r\n"},{"id":"acfb5ac7-cf7b-4dab-a5d9-7cdc8587fcaa","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","equals":true,"description":"must place “client_credentials”"},{"key":"client_id","value":"","equals":true,"description":"must place the previously granted client application identifier"},{"key":"client_secret","value":"","equals":true,"description":"must place the previously granted client secret"},{"key":"scope","value":"","equals":true,"description":"must place the previously granted client scope, for example, “view-user”"}]},"url":"{{login_url}}/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"...\",\r\n \"error_description\": \"...\",\r\n \"hint\": \"...\",\r\n \"message\": \"...\"\r\n}"}],"_postman_id":"ead8f174-079c-4f44-8c99-66c3b8b7092f"},{"name":"Refresh token","id":"f0986048-36ae-4587-82c7-56c2b6296808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”
\n","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier
\n","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret
\n","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2
\n","type":"text"}]},"url":"{{login_url}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{login_url}}"],"query":[],"variable":[]}},"response":[{"id":"0d8a5593-2d8b-4e0a-8b23-f3303925ed38","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token_type\": \"Bearer\", // an access token type, which by the oAuth2 standard is “Bearer”\r\n \"expires_in\": 604800, // token expire time in seconds\r\n \"access_token\": \"eyJ0eXiJS1A … UzIi7_A\", // an access token, which is used in API requests, to authorize user\r\n \"refresh_token\": \"def5020c40f … d20b6a62\" // an access renewal token, which is used when access token is expired (step 3)\r\n}\r\n"},{"id":"0982b5ea-7e61-4738-a452-66b27fd86920","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","description":"must place “refresh_token”","type":"text"},{"key":"client_id","value":"","description":"must place the previously granted client application identifier","type":"text"},{"key":"client_secret","value":"","description":"must place the previously granted client secret","type":"text"},{"key":"refresh_token","value":"","description":"must place the “refresh_token”, which was obtained in step 2","type":"text"}]},"url":"{{login_url}}/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"...\",\r\n \"error_description\": \"...\",\r\n \"hint\": \"...\",\r\n \"message\": \"...\"\r\n}"}],"_postman_id":"f0986048-36ae-4587-82c7-56c2b6296808"}],"id":"27f2ba4e-d472-429d-9a63-22ad2aed28c2","description":"1. To create a new client, you need to send an email to \"support@mykoob.com\" stating:
\n2. After receiving the authorization data from the e-mail (client application identifier - client_id, associated password - client_secret and available scopes), you can make requests against the Mykoob authorization server - {{login_url}}/oauth/.
\nKeep the client_id, associated secret, and scopes in a safe place. If you have any questions or problems, please contact support@mykoob.com. In case of additional rights, for specific needs, contact the support service by the email above.
\nClient credentials authentication is for private use only. To get access for clients credentials authentication, contact support. All clients will have separated scopes and restricted data access.
\nIf extra data is needed, please send request with explanation what kind of data is needed and where they would be used to \"support@mykoob.com\"
\n","_postman_id":"27f2ba4e-d472-429d-9a63-22ad2aed28c2"},{"name":"Public API methods","item":[{"name":"User info","id":"0ef4b008-7a88-432a-806d-3992f787acac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”
\n","type":"text"}],"url":"{{api_url}}/v1/user/info-old","urlObject":{"path":["v1","user","info-old"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7b8bdf19-2675-407a-8c8e-eae8c05aae77","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”","type":"text"}],"url":"{{api_url}}/v1/user/info-old"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"user_info\": {\r\n \"user_id\": \"...\",\r\n \"name\": \"...\",\r\n \"surname\": \"...\",\r\n \"email\": \"...\",\r\n \"country_code\": \"...\",\r\n \"city\": \"...\"\r\n }\r\n }"}],"_postman_id":"0ef4b008-7a88-432a-806d-3992f787acac"},{"name":"User schools info","id":"81a53c1a-e9bf-4cc5-a50c-804f183c5dcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”
\n","type":"text"}],"url":"{{api_url}}/v1/user/school_info-old","urlObject":{"path":["v1","user","school_info-old"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"6b75846b-e0b1-4ee2-8560-97bc132f1246","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”","type":"text"}],"url":"{{api_url}}/v1/user/school_info-old"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"user_school_info\": {\r\n \"user_id\": \"...\",\r\n \"schools\": [\r\n {\r\n \"school_id\": \"...\",\r\n \"school_user_id\": \"...\",\r\n \"name\": \"...\",\r\n \"roles\": [\r\n \"...\",\r\n \"...\"\r\n ]\r\n },\r\n {\r\n \"school_id\": \"...\",\r\n \"school_user_id\": \"...\",\r\n \"name\": \"...\",\r\n \"roles\": [\r\n \"...\",\r\n \"...\"\r\n ]\r\n }\r\n ]\r\n } \r\n }"}],"_postman_id":"81a53c1a-e9bf-4cc5-a50c-804f183c5dcd"},{"name":"User basic data","id":"77207836-b35f-45ba-8066-82bac2d78426","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”
\n","type":"text"}],"url":"{{api_url}}/v1/user/basic-old","urlObject":{"path":["v1","user","basic-old"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"25267970-1d7e-4fa7-a1be-9400b14db3b7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”","type":"text"}],"url":"{{api_url}}/v1/user/basic-old"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ID\": \"...\",\r\n \"Name\": \"...\",\r\n \"Middlename\": \"...\",\r\n \"Surname\": \"...\",\r\n \"E-Mail\": \"...\",\r\n \"UserGroups\": {\r\n \"Teacher\": {\r\n \"UserSchools\": {\r\n \"...school_name...\": {\r\n \"school_id\": \"...\",\r\n \"Subjects\": [\r\n \"...\",\r\n \"...\"\r\n ]\r\n },\r\n \"...school_name...\": {\r\n \"school_id\": \"...\",\r\n \"Subjects\": [\r\n \"...\",\r\n \"...\"\r\n ]\r\n }\r\n }\r\n },\r\n \"Class Teacher\": {\r\n \"...school_name...\": {\r\n \"school_id\": \"...\"\r\n }\r\n },\r\n \"Student\": {\r\n \"UserSchools\": {\r\n \"...school_name...\": {\r\n \"school_id\": \"...\",\r\n \"ClassName\": \"...\",\r\n \"Classes\": [\r\n \"...\"\r\n ],\r\n \"ClassList\": [\r\n {\r\n \"name\": \"...\",\r\n \"level\":\"...\"\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n }\r\n}"}],"_postman_id":"77207836-b35f-45ba-8066-82bac2d78426"},{"name":"User personal id","id":"53860bc2-116b-4898-ab19-49f04132aa49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Authorization header must place “access_token” after “Bearer ”
\n","type":"text"}],"url":"{{api_url}}/v1/user/personal_id-old","urlObject":{"path":["v1","user","personal_id-old"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"ddfe66c7-a069-4527-8a76-5970e21c87c7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{api_url}}/v1/user/personal_id-old"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"personal_id\": {\r\n \"personal_id\": \"...\"\r\n }\r\n}"}],"_postman_id":"53860bc2-116b-4898-ab19-49f04132aa49"}],"id":"2542b74f-184b-4f36-ac12-0cf93e8e734b","description":"These API methods are possible only with User authorization process. API with client credentials is private and sent separately.
\n","_postman_id":"2542b74f-184b-4f36-ac12-0cf93e8e734b"}]}