Download OpenAPI specification:Download
This is a in progress documentation for SokoPro REST API.
Remarks:
- the endpoints of some download and upload operations have a different server providing streaming capabilities
- at some point, the integer type of id's (of projects, folders and files) will be deprecated in favor of string uuid's exclusively.
This API uses OAuth2 with client_id and grant_type as request parameters
Security scheme type: | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://api.sokopro.fi/api/oauth2/authorize Token URL: https://api.sokopro.fi/api/oauth2/token Scopes:
|
password OAuth Flow | Token URL: https://api.sokopro.fi/api/oauth2/token Scopes:
|
clientCredentials OAuth Flow | Token URL: https://api.sokopro.fi/api/oauth2/token Scopes:
|
The authentication methods required for successful operation authentication.
Can be used to get client_credentials or password_grant by defining grant_type to client_credentials or password_grant
Query parameters | authorization_code (object) or client_credentials (object) or password_grant (object) Query parameters to be used for token request. It's recommended to use authorization_code. Other grant types are supported for previous users. |
After successful authentication return user specific token
User has passed incorect credentials or does not have access to this feature. See the response for more specific reason
Validation error. See the response for more specific reason
Unknown error
Authorize client
response_type required | string Value: "code" For the moment supported response_type is code |
client_id required | string Example: client_id=exampleclientid Registered client identifier |
redirect_uri required | string Example: redirect_uri=httpspreviously.requested.redirect.address.com Client's redirection endpoint, which has been added to the client during client registration |
scope required | string Value: "full_access" For the moment only supported scope is full_access |
state required | string State value from client |
After successful authentication return user specific token
User has passed incorect credentials or does not have access to this feature. See the response for more specific reason
Validation error. See the response for more specific reason
Unknown error
Authorize client
response_type required | string Value: "code" For the moment supported response_type is code |
client_id required | string Registered client identifier |
redirect_uri required | string Client's redirection endpoint, which has been added to the client during client registration |
scope required | string Value: "full_access" For the moment only supported scope is full_access |
state required | string State value from client |
After successful authentication return user specific token
User has passed incorect credentials or does not have access to this feature. See the response for more specific reason
Validation error. See the response for more specific reason
Unknown error
Specific information about the user
Current user
Invalid ID supplied
Folder wasn't found or user didn't have access to given folder
Unknown error
Check validity of current token
OK
Invalid token
Invalid token
Unknown error
List all projects what user has
List of user's projects or empty if there's none
Get information about specific project
projectId required | integer <int64> Id of the project as integer |
successful operation, for the moment parent value points to incorrect folder and shouldn't be used for navigation
Project doesn't exist or user has no access to the project
Unknown error
Get project's metadata schema which is useful as an example when saving uploaded files
projectId required | integer <int64> Id of the project as integer |
successful operation, for the moment parent value points to incorrect folder and shouldn't be used for navigation
Failed to retrieve project metadata for given project
List the content of the folder
projectId required | integer <int64> Id of the project as integer |
folderId required | integer <int64> Id of the folder as integer |
Content of requested folder
Not found
Unprocessable Entity, usually caused by validation error
Return revision of the filer
fileId required | integer <int64> If of file as integer |
successful operation, for the moment parent value points to incorrect folder and shouldn't be used for navigation
Invalid ID supplied
Folder wasn't found or user didn't have access to given folder
Return latest revision of requested file or error
fileUuid required | string fileUuid of the requested file |
successful operation, return information of the latest revision of the file
Bad Request
Unauthorized
Revision for given file can not be found
Unprocessable Entity, usually caused by validation error