Skip to main content

Overview

The EmpresaImages API manages visual assets for companies, including logos and banner images. Each company can have associated image files that are uploaded and stored on the server.

Base Endpoint

POST   /Database/Database/empresaimages/
GET    /Database/Database/empresaimages/
GET    /Database/Database/empresaimages/{id_images}/
PUT    /Database/Database/empresaimages/{id_images}/
PATCH  /Database/Database/empresaimages/{id_images}/
DELETE /Database/Database/empresaimages/{id_images}/

The EmpresaImages Object

id_images
integer
required
Unique identifier for the image record (auto-generated)
id_empresa
integer
required
Foreign key reference to the Empresa (Company) that owns these images
Company logo image file. Uploaded to empresas/logos/ directory. Supported formats: JPG, PNG, GIF
banner
file
required
Company banner image file. Uploaded to empresas/banners/ directory. Supported formats: JPG, PNG, GIF
estado
integer
Status of the image record. Defaults to 1 (active)

Image Upload Guidelines

Recommended Specifications:
  • Logo: 512x512px (square), PNG with transparent background preferred
  • Banner: 1200x400px (3:1 ratio), JPG or PNG
  • Maximum file size: 5MB per image
  • Formats: JPG, PNG, GIF

Upload Company Images

When creating or updating company images, use multipart/form-data encoding to handle file uploads.
curl -X POST https://api.example.com/Database/Database/Database/empresaimages/ \
  -H "Content-Type: multipart/form-data" \
  -F "id_empresa=12" \
  -F "logo=@/path/to/logo.png" \
  -F "banner=@/path/to/banner.jpg" \
  -F "estado=1"
{
  "id_images": 8,
  "id_empresa": 12,
  "logo": "/media/empresas/logos/logo_techcorp_2024.png",
  "banner": "/media/empresas/banners/banner_techcorp_2024.jpg",
  "estado": 1
}

Retrieve Company Images

curl -X GET https://api.example.com/Database/Database/Database/empresaimages/8/
{
  "id_images": 8,
  "id_empresa": 12,
  "logo": "/media/empresas/logos/logo_techcorp_2024.png",
  "banner": "/media/empresas/banners/banner_techcorp_2024.jpg",
  "estado": 1
}

List All Company Images

curl -X GET https://api.example.com/Database/Database/Database/empresaimages/
[
  {
    "id_images": 8,
    "id_empresa": 12,
    "logo": "/media/empresas/logos/logo_techcorp_2024.png",
    "banner": "/media/empresas/banners/banner_techcorp_2024.jpg",
    "estado": 1
  },
  {
    "id_images": 9,
    "id_empresa": 13,
    "logo": "/media/empresas/logos/logo_marketing_plus.png",
    "banner": "/media/empresas/banners/banner_marketing_plus.jpg",
    "estado": 1
  }
]

Update Company Images

You can update individual images or both at once using PUT or PATCH methods.
curl -X PATCH https://api.example.com/Database/Database/Database/empresaimages/8/ \
  -H "Content-Type: multipart/form-data" \
  -F "logo=@/path/to/new_logo.png"
{
  "id_images": 8,
  "id_empresa": 12,
  "logo": "/media/empresas/logos/new_logo_techcorp_2024.png",
  "banner": "/media/empresas/banners/banner_techcorp_2024.jpg",
  "estado": 1
}

Delete Company Images

curl -X DELETE https://api.example.com/Database/Database/Database/empresaimages/8/
HTTP 204 No Content

Filter Images by Company

You can filter images by company using query parameters:
curl -X GET "https://api.example.com/Database/Database/Database/empresaimages/?id_empresa=12"
[
  {
    "id_images": 8,
    "id_empresa": 12,
    "logo": "/media/empresas/logos/logo_techcorp_2024.png",
    "banner": "/media/empresas/banners/banner_techcorp_2024.jpg",
    "estado": 1
  }
]

Image File Paths

The API returns relative paths to image files. To construct full URLs:
  • Production: https://yourdomain.com{logo_path}
  • Development: http://localhost:8000{logo_path}

Example Full URL Construction

Python
base_url = "https://yourdomain.com"
logo_url = base_url + response_data['logo']
banner_url = base_url + response_data['banner']

print(f"Logo: {logo_url}")
print(f"Banner: {banner_url}")
JavaScript
const baseUrl = 'https://yourdomain.com';
const logoUrl = baseUrl + data.logo;
const bannerUrl = baseUrl + data.banner;

console.log(`Logo: ${logoUrl}`);
console.log(`Banner: ${bannerUrl}`);

Build docs developers (and LLMs) love