Hasfy Documentation

Référence API

Documentation complète de l'API Hasfy

Référence API

Documentation complète de l'API Hasfy.

Authentification

Toutes les requêtes API nécessitent une clé API :

curl -H "Authorization: Bearer VOTRE_CLE_API" \
  https://api.hasfy.fr/v1/endpoint

Endpoints

GET /api/projects

Récupère la liste de vos projets.

Paramètres de requête :

  • page (number) : Numéro de page (défaut: 1)
  • limit (number) : Nombre d'éléments par page (défaut: 10)

Réponse :

{
  "data": [
    {
      "id": "proj_123",
      "name": "Mon Projet",
      "createdAt": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42
  }
}

POST /api/projects

Crée un nouveau projet.

Corps de la requête :

{
  "name": "Nouveau Projet",
  "description": "Description du projet"
}

Réponse :

{
  "id": "proj_124",
  "name": "Nouveau Projet",
  "description": "Description du projet",
  "createdAt": "2025-01-01T00:00:00Z"
}

GET /api/projects/:id

Récupère les détails d'un projet.

Paramètres :

  • id (string) : ID du projet

Réponse :

{
  "id": "proj_123",
  "name": "Mon Projet",
  "description": "Description",
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-15T00:00:00Z"
}

PATCH /api/projects/:id

Met à jour un projet.

Corps de la requête :

{
  "name": "Nouveau nom",
  "description": "Nouvelle description"
}

DELETE /api/projects/:id

Supprime un projet.

Réponse :

{
  "success": true,
  "message": "Projet supprimé avec succès"
}

Codes d'erreur

| Code | Description | |------|-------------| | 400 | Requête invalide | | 401 | Non authentifié | | 403 | Non autorisé | | 404 | Ressource introuvable | | 500 | Erreur serveur |

Rate Limiting

L'API est limitée à :

  • 100 requêtes/minute pour le plan gratuit
  • 1000 requêtes/minute pour le plan Pro
  • Illimité pour le plan Enterprise

SDKs

Nous proposons des SDKs officiels :

JavaScript/TypeScript

npm install @hasfy/sdk
import { Hasfy } from '@hasfy/sdk';

const hasfy = new Hasfy({
  apiKey: 'votre_clé_api',
});

const projects = await hasfy.projects.list();

Python

pip install hasfy-sdk
from hasfy import Hasfy

hasfy = Hasfy(api_key='votre_clé_api')
projects = hasfy.projects.list()

Webhooks

Configurez des webhooks pour recevoir des notifications en temps réel.

Événements disponibles

  • project.created
  • project.updated
  • project.deleted

Configuration

const webhook = await hasfy.webhooks.create({
  url: 'https://votre-app.com/webhook',
  events: ['project.created', 'project.updated'],
});

Support

Besoin d'aide ? Contactez-nous à api@hasfy.fr

    Référence API - Hasfy Docs