nerdcult
/
api
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
api/docs
History
antifallobst f6fc479f5b
docs(api): renamed docs/API.md to docs/README.md 		2023-08-18 18:06:43 +02:00
..
account docs(api): moved into 'docs' folder and splitted into multiple files 2023-08-18 18:05:12 +02:00
project docs(api): moved into 'docs' folder and splitted into multiple files 2023-08-18 18:05:12 +02:00
user/specific docs(api): moved into 'docs' folder and splitted into multiple files 2023-08-18 18:05:12 +02:00
README.md docs(api): renamed docs/API.md to docs/README.md 2023-08-18 18:06:43 +02:00

README.md

API

All API endpoints are accessible with this base URL: https://api.nerdcult.net/. Some API endpoints require an Authorization HTTP header. The token for this can be aquired using the /account/authenticate endpoint.

Implementation Status

  • /account
    • /register
    • /verify
    • /authenticate
    • /delete
    • /tokens
    • /tokens
    • /follows
    • /followers
  • /user/{username}
    • /info
    • /follow
    • /follows
    • /followers
    • /projects
  • /project
    • /create
    • /{projectname}
      • /info
      • /join

TODO

  • Password checking on registration
  • usage examples
  • anonymized account deletion reason
  • account deactivation
  • account bound rate limit
  • id support for user and project specific calls