METHOD ENDPOINT USAGE PARAMS EXTRAS
POST /api/v1/auth/signin Sign in
  • email required | max:255
  • password required | max:255
POST /api/v1/auth/signup Sign up
  • nif required | max:20
  • name required | max:255
  • phone required | max:20
  • email required | max:255
  • password required | max:255
  • translation_id required | numeric
  • role_id required | numeric
  • address_id nullable | numeric
METHOD ENDPOINT USAGE PARAMS EXTRAS
GET /api/v1/translations Get all translations
GET /api/v1/translations/{id} Get one translation
METHOD ENDPOINT USAGE PARAMS EXTRAS
GET /api/v1/roles Get all roles
GET /api/v1/roles/{id} Get one role
METHOD ENDPOINT USAGE PARAMS EXTRAS
POST /api/v1/addresses?lang={code} Store an address
  • address required | max:255
  • city required | max:100
  • province required | max:100
  • zip required | max:20
  • user_id nullable | numeric
Oauth
GET /api/v1/addresses Get all addresses Oauth
GET /api/v1/addresses/{id} Get one address Oauth
PUT /api/v1/addresses/{id} Update an address
  • address required | max:255
  • city required | max:100
  • province required | max:100
  • zip required | max:20
  • user_id nullable | numeric
Oauth
DELETE /api/v1/addresses/{id} Remove an address Oauth
METHOD ENDPOINT USAGE PARAMS EXTRAS
POST /api/v1/users Store an user
  • nif required | max:20
  • name required | max:255
  • phone required | max:20
  • email required | max:255
  • password required | max:255
  • translation_id required | numeric
  • role_id required | numeric
  • address_id nullable | numeric
Oauth
GET /api/v1/users Get all users Oauth
GET /api/v1/users/{id} Get one user by id Oauth
GET /api/v1/user Get one by token Oauth
PUT /api/v1/users/{id} Update an user
  • nif required | max:20
  • name required | max:255
  • phone required | max:20
  • email required | max:255
  • translation_id required | numeric
  • role_id required | numeric
  • address_id nullable | numeric
Oauth
DELETE /api/v1/users/{id} Remove an user Oauth
METHOD ENDPOINT USAGE PARAMS EXTRAS
POST /api/v1/categories?lang={code} Store a category
  • name required | max:96
Oauth
GET /api/v1/categories/{id}?lang={code}&year={year} Get all categories Oauth
GET /api/v1/categories/{id}?lang={code}&year={year} Get one category Oauth
PUT /api/v1/categories/{id}?lang={code}&year={year} Update a category
  • name required | max:96
Oauth
DELETE /api/v1/categories/{id}?lang={code}&year={year} Remove a category Oauth
METHOD ENDPOINT USAGE PARAMS EXTRAS
POST /api/v1/documents Store a document
  • alias required | max:255
  • category_id required | numeric
  • user_id required | numeric
  • file required
Oauth
GET /api/v1/documents Get all documents Oauth
GET /api/v1/documents/{id} Get one document Oauth
GET /api/v1/documents/download/{id} Download a document
PUT /api/v1/documents/{id} Update a document
  • alias required | max:255
  • category_id required | numeric
  • user_id required | numeric
  • file required
Oauth
DELETE /api/v1/documents/{id}?force={0|1} Remove a document Oauth