API REST

API de ReceiveIt

Integre la recepción de archivos en sus aplicaciones con nuestra API REST segura y documentada.

99.9%

Uptime

<100ms

Latencia

10GB

Archivo máx

24/7

Soporte

Autenticación

La API de ReceiveIt utiliza autenticación por clave API. Todas las solicitudes deben incluir su clave API en el encabezado.

Clave API

Su clave API está disponible en su panel de control. Debe incluirse en todas las solicitudes HTTP.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Plan Gratuito

1000

sol/día

Plan Pro

10000

sol/día

Plan Empresa

∞

Ilimitado

Endpoints de la API

POST

/api/v1/pages

Crear una página de depósito

Cree una nueva página de depósito personalizada

Paramètres

{
  "name": "Mi página",
  "description": "Descripción",
  "logo_url": "https://example.com/logo.png",
  "primary_color": "#3B82F6",
  "secondary_color": "#8B5CF6",
  "welcome_message": "Bienvenido",
  "max_file_size": 10485760,
  "allowed_extensions": ["jpg", "png", "pdf"],
  "expires_at": "2024-12-31T23:59:59Z"
}

Réponse

{
  "success": true,
  "data": {
    "id": "page_123456",
    "name": "Mi página",
    "url": "https://receiveit.io/depot/abc123",
    "created_at": "2024-01-15T10:30:00Z",
    "status": "active"
  }
}

GET

/api/v1/pages

Listar páginas

Obtenga la lista de todas sus páginas de depósito

Paramètres de requête

?page=1&limit=20&status=active&search=nombre

Réponse

{
  "success": true,
  "data": {
    "pages": [
      {
        "id": "page_123456",
        "name": "Mi página",
        "url": "https://receiveit.io/depot/abc123",
        "status": "active",
        "file_count": 15,
        "created_at": "2024-01-15T10:30:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 45
    }
  }
}

GET

/api/v1/pages/{page_id}/files

Obtener archivos

Listar todos los archivos recibidos en una página

Paramètres de requête

?page=1&limit=50&sort=created_at&order=desc

Réponse

{
  "success": true,
  "data": {
    "files": [
      {
        "id": "file_789012",
        "name": "documento.pdf",
        "size": 2048576,
        "type": "application/pdf",
        "url": "https://receiveit.io/files/abc123",
        "uploaded_at": "2024-01-15T14:30:00Z",
        "uploader_ip": "192.168.1.1"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 125
    }
  }
}

Webhooks

Reciba notificaciones en tiempo real cuando se suban archivos a sus páginas.

file.uploaded

Se activa cuando se sube un archivo

file.downloaded

Se activa cuando se descarga un archivo

file.deleted

Se activa cuando se elimina un archivo

Ejemplo de payload

{
  "event": "file.uploaded",
  "timestamp": "2024-01-15T14:30:00Z",
  "data": {
    "file_id": "file_789012",
    "page_id": "page_123456",
    "filename": "documento.pdf",
    "size": 2048576,
    "type": "application/pdf"
  },
  "signature": "sha256=abc123..."
}

Ejemplos de código

const axios = require('axios');

const API_KEY = 'su_clave_api';
const BASE_URL = 'https://api.receiveit.io/v1';

// Crear una página
async function createPage() {
  try {
    const response = await axios.post(`${BASE_URL}/pages`, {
      name: 'Mi página',
      description: 'Página para recibir archivos',
      primary_color: '#3B82F6'
    }, {
      headers: {
        'Authorization': `Bearer ${API_KEY}`,
        'Content-Type': 'application/json'
      }
    });
    
    console.log('Página creada:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}