Docs/Primeros pasos

Primeros pasos

Esta guía le muestra cómo integrar Apertur en su aplicación. Creará un proyecto, generará una clave API, configurará un destino, creará una sesión de subida y recibirá su primera imagen.

1

Regístrese y cree un proyecto

Visite apertur.ca/register y cree su cuenta. Una vez que haya iniciado sesión, navegue a Panel → Proyectos → Nuevo proyecto.

Cada proyecto tiene sus propias claves API, destinos e historial de subidas. Elija un plan al crear el proyecto.

2

Cree una clave API

Dentro de su proyecto, vaya a Claves API → Nueva clave. Asigne una etiqueta a la clave para facilitar su identificación.

Copie su clave inmediatamente — no se mostrará de nuevo. Las claves siguen el formato:

aptr_a1b2c3d4e5f6...
3

Configure un destino

Antes de crear sesiones de subida, debe indicar a Apertur dónde entregar las fotos. Navegue a Panel → Su proyecto → Destinos → Nuevo destino.

Apertur admite 9 tipos de destinos: Webhook, S3, Google Drive, Dropbox, OneDrive, FTP/SFTP, WebDAV, Azure Blob y Box.

Inicio rápido: destino Webhook

  1. Vaya a Destinos → Nuevo destino
  2. Elija "Webhook" como tipo
  3. Ingrese la URL de su endpoint y guarde — anote el ID de destino

Al crear una sesión de subida, pase los destination_ids para especificar dónde se entregan las imágenes. Si los omite, se utilizan los destinos predeterminados de la clave API.

Consulte la documentación de sesiones de subida para todos los tipos de destinos y sus opciones de configuración.

4

Cree una sesión de subida

Realice una solicitud POST a /v1/sessions con su clave API. Pase un array de destination_ids para especificar dónde se entregan las imágenes.

curl -X POST https://api.apertur.ca/v1/sessions \
  -H "Authorization: Bearer aptr_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "destination_ids": ["dest_xxxx"],
    "tags": ["user:usr_123"]
  }'

Respuesta

{
  "uuid": "sess_01HX4ABCDEFGHIJKLMN",
  "destinations": [
    { "id": "dest_xxxx", "type": "webhook", "name": "My Webhook" }
  ],
  "long_polling": false,
  "expires_at": "2024-03-29T10:00:00Z",
  "password_protected": false
}
5

Muestre el código QR a su usuario

La respuesta incluye un uuid que identifica la sesión. Construya la URL de subida y genere un código QR para mostrarlo en su aplicación. Cuando el usuario lo escanee, accederá a la interfaz de Apertur — sin necesidad de instalar una aplicación.

También puede compartir la URL directamente por SMS o correo electrónico. La interfaz es una Progressive Web App optimizada para cámaras móviles.

6

Reciba imágenes en su destino

Después de que el usuario envíe sus fotos, Apertur entrega cada imagen a sus destinos configurados. Para destinos webhook, realizamos un POST de cada imagen en formato multipart con metadatos de sesión en los encabezados.

// Express.js webhook handler
app.post("/webhook", express.raw({ type: "multipart/*" }), (req, res) => {
  const sessionId = req.headers["x-aptr-session-id"];
  const imageIndex = req.headers["x-aptr-image-index"];
  const signature = req.headers["x-aptr-signature"];

  // Verify signature (recommended)
  if (!verifySignature(req.body, signature, process.env.WEBHOOK_SECRET)) {
    return res.status(401).end();
  }

  // Process the image...
  res.status(200).end();
});

Consulte la documentación de Webhooks para obtener detalles sobre la verificación de firmas y la política de reintentos.

Siguiente: Autenticación →