Additional Notes

Security Considerations

  • Always validate file types and sizes on the frontend before upload

  • Store session tokens securely (never in plain text)

  • Implement proper error handling to avoid exposing sensitive information

  • Use HTTPS in production environments

Performance Tips

  • Implement request caching for frequently accessed data

  • Use image compression before upload

  • Implement pagination for large data sets

  • Add loading states for better user experience

API Response Formats

  • All responses follow a consistent format with Status, Message, and optional Details

  • Success status can be "Success", "Successfull", or "Successful" (note the inconsistency in the API)

  • Error status is always "Error" or "ERROR"

  • Always check the status field before processing response data

Required Headers

  • Authentication: Authorization: Bearer <access_token> for all protected endpoints

  • Content-Type:

    • application/json for JSON requests

    • multipart/form-data for file uploads (don't set manually, let the browser/framework handle it)

File Upload Limitations

  • Resume: PDF only, max 5MB

  • Profile Pictures: JPG, JPEG, PNG, GIF only, max 5MB

  • Company Logo: JPG, JPEG, PNG, GIF only, max 5MB

  • PWD ID: JPG, JPEG, PNG, GIF only, max 5MB

Status Codes

  • 200: Success

  • 401: Unauthorized (invalid or missing token)

  • 404: Resource not found

  • 500: Internal server error

Last updated