Home

Welcome to the Nitrohire docs. Here is your quick guide to the API

  1. Take a look at google drive folder to understand what kind of project we're working on. If you have no permission to access the folder, ask for permission.
  2. Visit glossary page. It helps you to understand what entities we're operating with.
  3. In section "General API features" you can find general recommendations like how to handle exceptions or work with pagination.
  4. Then move to workflows description. It describes some use-cases you need to handle on the client-side.
  5. Here is a list of features you need to implement on client-side to successfully integrate frontend app and the backend.
  6. You can find a list of all available API endpoints documented with swagger
  7. Here is a postman collection available. It covers a few API endpoints. If you're an active postman user, feel free to extend the collection and send the updated file to the backend team.