README.md

BecauseOfProg's API

📚 Fetch all kind of information related to the BecauseOfProg

• Change log
• License
• Topics
  • Authentication
  • Pagination
  • Permissions
• Resources
  • Post
  • Blog post
  • Comment
  • User

Introduction

Welcome on the BecauseOfProg's API ! From there, you can fetch data available on our website :

• Users registered on the website
• Posts and blog posts that we published

First of all, you need a URL in order to access it. The root URL for the API is https://api.becauseofprog.fr. This URL is followed by the version of this format : v{number}. You can find versions below :

Version	Status
1	Available

Requests

Some requests need user to be authenticated : learn mode on the Authentication topic.

Every request to the API that require a body must be JSON-formatted, with an object as a container.

Responses

Every response is in JSON format, and has in its body a code which is 1 or 0, depending on the request's success or not, and a data variable containing the requested data.