Vue d'ensemble

L'API Mapfolio fournit un accès programmatique aux données des entreprises suisses via une interface RESTful. Tous les points de terminaison sont documentés à l'aide de la spécification OpenAPI 3.0, garantissant la cohérence et la facilité d'intégration.

Pour commencer

Authentification

L'API Mapfolio utilise l'authentification par clé API. Vous pouvez obtenir votre clé API depuis vos paramètres de compte.

En-tête de clé API :

X-API-Key: mapf_votre_cle_api_ici

Jeton Bearer (Alternative) :

Authorization: Bearer mapf_votre_cle_api_ici

URL de base

Toutes les requêtes API doivent être effectuées vers :

https://mapfolio.app

Limitation du débit

Les requêtes API sont limitées en débit pour assurer une utilisation équitable :

Requêtes authentifiées : 1000 requêtes par heure par clé API
Requêtes non authentifiées : 10 requêtes par heure par adresse IP

Les informations de limitation du débit sont incluses dans les en-têtes de réponse :

X-RateLimit-Limit : Nombre maximum de requêtes autorisées
X-RateLimit-Remaining : Requêtes restantes dans la fenêtre actuelle
X-RateLimit-Reset : Horodatage Unix de la réinitialisation de la limite

Points de terminaison disponibles

Recherche d'entreprises

Recherchez des entreprises avec des options de filtrage avancées :

Recherche textuelle dans les noms d'entreprises
Filtrage par canton (cantons suisses)
Filtrage par statut d'entreprise
Support de pagination

Détails des entreprises

Récupérez des informations détaillées sur des entreprises spécifiques :

Données de profil d'entreprise
Informations de localisation
Statut juridique
Détails d'enregistrement

Statistiques

Accédez aux statistiques agrégées sur les entreprises suisses :

Comptes globaux d'entreprises
Statistiques au niveau des cantons
Distributions basées sur les lettres
Comptes de combinaisons de deux lettres

Autocomplétion

Obtenez des suggestions d'autocomplétion pour :

Noms d'entreprises
Villes
Codes postaux

Entreprises aléatoires

Récupérez des échantillons d'entreprises aléatoires pour les tests et l'exploration.

Format de réponse

Toutes les réponses API réussies suivent une structure cohérente :

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Les réponses d'erreur incluent des informations détaillées :

{
  "error": "Message d'erreur",
  "details": "Détails d'erreur supplémentaires"
}

Codes d'erreur

400 Bad Request : Paramètres de requête invalides
401 Unauthorized : Clé API manquante ou invalide
403 Forbidden : Permissions insuffisantes
404 Not Found : Ressource introuvable
429 Too Many Requests : Limite de débit dépassée
500 Internal Server Error : Erreur côté serveur

Spécification OpenAPI

La spécification OpenAPI 3.0 complète est disponible à :

Documentation interactive : /api-docs.html
OpenAPI JSON : /api/docs/openapi.json

Vous pouvez utiliser la spécification OpenAPI avec n'importe quel outil compatible :

Swagger UI
Postman
Insomnia
Générateurs de code pour bibliothèques clientes

Exemples de code

cURL

curl -H "X-API-Key: mapf_votre_cle_api_ici" \
  https://mapfolio.app/api/search?q=technologie

JavaScript (Fetch)

const response = await fetch('https://mapfolio.app/api/search?q=technologie', {
  headers: {
    'X-API-Key': 'mapf_votre_cle_api_ici'
  }
})
const data = await response.json()

Python (Requests)

import requests

headers = {'X-API-Key': 'mapf_votre_cle_api_ici'}
response = requests.get(
  'https://mapfolio.app/api/search',
  params={'q': 'technologie'},
  headers=headers
)
data = response.json()

Support

Pour le support API et les questions :

Documentation : Visitez la documentation API interactive
Email : support@mapfolio.app
Problèmes : Signalez les problèmes via votre tableau de bord de compte

Conditions d'utilisation

En utilisant l'API Mapfolio, vous acceptez nos Conditions de service et notre Politique de confidentialité. Veuillez consulter les limites de débit et les directives d'utilisation pour assurer la conformité.