Cargas

Un archivo grande enviado por partes: la entrada de una operación masiva.

Cargando el índice de búsqueda…

Cargas

Objetos

Upload

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • file_namestringobligatorio

    Nombre del archivo dado al iniciar la carga.

  • sizeintegerobligatorio

    Tamaño del archivo completo en bytes.

  • receivedintegerobligatorio

    Bytes recibidos: el desplazamiento de la siguiente parte.

  • completebooleanobligatorio

    El archivo está armado: una operación masiva puede tomarlo por id. Después de eso la carga deja de existir.

  • chunk_bytesintegerobligatorio

    Tamaño máximo de una parte en bytes.

  • expires_atstring (date-time)obligatorio

    Después de este momento una carga no usada se elimina.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

Endpoints

Obtener una carga de archivo por partes: cuánto se recibió

get/uploads/{upload}

Scope: bulk:read

Parámetros

Ruta

  • uploadintegerobligatorio

    ID de la carga.

Respuestas

200Éxito

application/json

Devuelve Upload

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/uploads/{upload}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}

Iniciar una carga de archivo por partes: la entrada de una operación masiva

post/uploads

Scope: bulk:write

Parámetros

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Cuerpo de la solicitud application/json

  • file_namestringobligatorio

    Nombre del archivo dado al iniciar la carga.

    Largo máximo:
    255
  • sizeintegerobligatorio

    Tamaño del archivo completo en bytes.

    Mínimo:
    1
    Máximo:
    268435456

Respuestas

201Creado

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true

application/json

Devuelve Upload

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/uploads" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Cuerpo de la solicitud — body.json
{
  "file_name": "string",
  "size": 1
}
Ejemplo de respuesta · 201
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}

Agregar una parte del archivo como cuerpo crudo

post/uploads/{upload}/chunks

Scope: bulk:write

Parámetros

Ruta

  • uploadstringobligatorio

    ID de la carga.

Query

  • offsetintegerobligatorio

    Byte del archivo donde empieza la parte: igual a received de la carga, si no, 409 upload_offset_mismatch. La parte en sí es el cuerpo crudo de la solicitud.

    Mínimo:
    0

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Cuerpo de la solicitud application/octet-stream

string (binary)

Respuestas

200Éxito

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true

application/json

Devuelve Upload

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/uploads/{upload}/chunks?offset=<offset>" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @file
Ejemplo de respuesta · 200
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}