Premiers pas
Ce guide vous accompagne dans l'intégration d'Apertur à votre application. Vous allez créer un projet, générer une clé API, configurer une destination, créer une session d'envoi et recevoir votre première image.
Inscription et création d'un projet
Rendez-vous sur apertur.ca/register et créez votre compte. Une fois connecté, naviguez vers Tableau de bord → Projets → Nouveau projet.
Chaque projet possède ses propres clés API, ses destinations et son historique d'envois. Choisissez un plan lors de la création du projet.
Créer une clé API
Dans votre projet, accédez à Clés API → Nouvelle clé. Donnez un libellé à la clé pour l'identifier facilement.
Copiez votre clé immédiatement — elle ne sera plus affichée par la suite. Les clés suivent le format :
aptr_a1b2c3d4e5f6...
Configurer une destination
Avant de créer des sessions d'envoi, vous devez indiquer à Apertur où livrer les photos. Naviguez vers Tableau de bord → Votre projet → Destinations → Nouvelle destination.
Apertur prend en charge 9 types de destinations : Webhook, S3, Google Drive, Dropbox, OneDrive, FTP/SFTP, WebDAV, Azure Blob et Box.
Démarrage rapide : destination Webhook
- Accédez à Destinations → Nouvelle destination
- Choisissez « Webhook » comme type
- Entrez l'URL de votre endpoint et enregistrez — notez l'identifiant de destination
Lors de la création d'une session d'envoi, vous transmettez les destination_ids pour spécifier où les images sont livrées. Si vous les omettez, les destinations par défaut de la clé API sont utilisées.
Consultez la documentation des sessions d'envoi pour tous les types de destinations et leurs options de configuration.
Créer une session d'envoi
Envoyez une requête POST à /v1/sessions avec votre clé API. Transmettez un tableau de destination_ids pour spécifier où les images sont livrées.
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"]
}'Réponse
{
"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
}Afficher le QR code à votre utilisateur
La réponse inclut un champ uuid qui identifie la session. Construisez l'URL d'envoi et générez un QR code à afficher dans votre application. Lorsque l'utilisateur le scanne, il est dirigé vers l'interface Apertur — aucune installation d'application requise.
Vous pouvez également partager l'URL directement par SMS ou courriel. L'interface est une application Web progressive optimisée pour les appareils photo mobiles.
Recevoir les images à votre destination
Après que l'utilisateur a soumis ses photos, Apertur livre chaque image à vos destinations configurées. Pour les destinations webhook, nous envoyons chaque image par POST au format multipart avec les métadonnées de session dans les en-têtes.
// 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();
});Consultez la documentation sur les webhooks pour les détails sur la vérification des signatures et la politique de nouvelles tentatives.