Add an API #15

New issue

Open

opened 2025-07-21 13:13:16 +00:00 by BlakeRain · 0 comments

BlakeRain commented

2025-07-21 13:13:16 +00:00

(Migrated from github.com)

Get information about the authenticated user
Get a list of teams that the user belongs to
List uploads, either those that belong to the user or a specific team (that they belong to)
Get information about a specific download
Modify configuration of an upload, respecting the permissions for team members
Download a file
Create a new upload. This will be interesting, as currently the app uses a multipart form to complete multiple uploads, but this might not be as nice for a JSON-based API.

I don't think that there is any reason to include administrative actions in an API, for now.

Need to have a think about how to implement authentication for the API. I think that letting the user generate an API key in their account will suffice for the time being. At some point we can think about adding scopes and such. At some point using something like OAuth will be nice, but that's quite a bit more work for a tiny project like this.

Need to add some API endpoints that can be used by tools and other integrations to interact with Parcel. Primarily this would allow management of uploads, both a user's and any team they are a member of. - [ ] Get information about the authenticated user - [ ] Get a list of teams that the user belongs to - [ ] List uploads, either those that belong to the user or a specific team (that they belong to) - [ ] Get information about a specific download - [ ] Modify configuration of an upload, respecting the permissions for team members - [ ] Download a file - [ ] Create a new upload. This will be interesting, as currently the app uses a multipart form to complete multiple uploads, but this might not be as nice for a JSON-based API. I don't think that there is any reason to include administrative actions in an API, for now. Need to have a think about how to implement authentication for the API. I think that letting the user generate an API key in their account will suffice for the time being. At some point we can think about adding scopes and such. At some point using something like OAuth will be nice, but that's quite a bit more work for a tiny project like this.