Authentification
L'API ReceiveIt utilise l'authentification par clé API. Toutes les requêtes doivent inclure votre clé API dans l'en-tête.
Clé API
Votre clé API est disponible dans votre tableau de bord. Elle doit être incluse dans toutes les requêtes HTTP.
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonPlan Gratuit
1000
req/jour
Plan Pro
10000
req/jour
Plan Entreprise
∞
Illimité
Endpoints API
POST
/api/v1/pagesCréer une page de dépôt
Créez une nouvelle page de dépôt personnalisée
Paramètres
{
"name": "Ma page de dépôt",
"description": "Description de la page",
"logo_url": "https://example.com/logo.png",
"primary_color": "#3B82F6",
"secondary_color": "#8B5CF6",
"welcome_message": "Bienvenue sur notre page de dépôt",
"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": "Ma page de dépôt",
"url": "https://receiveit.io/depot/abc123",
"created_at": "2024-01-15T10:30:00Z",
"status": "active"
}
}GET
/api/v1/pagesLister les pages
Récupérez la liste de toutes vos pages de dépôt
Paramètres de requête
?page=1&limit=20&status=active&search=nomRéponse
{
"success": true,
"data": {
"pages": [
{
"id": "page_123456",
"name": "Ma page de dépôt",
"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}/filesRécupérer les fichiers
Listez tous les fichiers reçus sur une page
Paramètres de requête
?page=1&limit=50&sort=created_at&order=descRéponse
{
"success": true,
"data": {
"files": [
{
"id": "file_789012",
"name": "document.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
Recevez des notifications en temps réel quand des fichiers sont déposés sur vos pages.
file.uploaded
Déclenché quand un fichier est déposé
file.downloaded
Déclenché quand un fichier est téléchargé
file.deleted
Déclenché quand un fichier est supprimé
Exemple de payload
{
"event": "file.uploaded",
"timestamp": "2024-01-15T14:30:00Z",
"data": {
"file_id": "file_789012",
"page_id": "page_123456",
"filename": "document.pdf",
"size": 2048576,
"type": "application/pdf"
},
"signature": "sha256=abc123..."
}Exemples de code
const axios = require('axios');
const API_KEY = 'your_api_key_here';
const BASE_URL = 'https://api.receiveit.io/v1';
// Créer une page de dépôt
async function createPage() {
try {
const response = await axios.post(`${BASE_URL}/pages`, {
name: 'Ma page de dépôt',
description: 'Page pour recevoir des fichiers',
primary_color: '#3B82F6'
}, {
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
}
});
console.log('Page créée:', response.data);
return response.data;
} catch (error) {
console.error('Erreur:', error.response.data);
}
}
// Lister les fichiers
async function getFiles(pageId) {
try {
const response = await axios.get(`${BASE_URL}/pages/${pageId}/files`, {
headers: {
'Authorization': `Bearer ${API_KEY}`
}
});
console.log('Fichiers:', response.data);
return response.data;
} catch (error) {
console.error('Erreur:', error.response.data);
}
}Support et ressources
Besoin d'aide pour intégrer l'API ? Nous sommes là pour vous accompagner.
Explorez nos autres solutions
Découvrez comment ReceiveIt peut s'adapter à vos besoins