overleaf / overleaf/overleaf

ShareLaTeX API

Open
#299 49 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

big feature enhancement
Dominant language
JavaScript
Stars
18.1k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Description

We're starting to think about a proper API for ShareLaTeX, and need your feedback on what you would need from something like this. So please can you comment here and let us know:

  1. What is your use case for the ShareLaTeX API (an app you're developing, a product integration, a personal back up script, etc)?
  2. Which data you would need access to do be able to do this (in as much detail as possible please). If you can speculate on the end points you would need that would be useful too (e.g. "I'd need access to be able to list projects owned by a user, see their names and owners, and then get the email addresses of the owners").

The API will likely use OAuth as an authentication mechanism, but comments on this are welcome too. What would you need from an auth flow?

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the issue discussion for the proposed ShareLaTeX API use cases, required data and endpoints, and OAuth authentication feedback. The issue does not identify implementation files, tests, or a concrete definition of done; its scope remains API design and requirements gathering.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.