Documentation développeur

Votre premier appel API, simplement.

Retrouvez ici l’essentiel pour connecter Papaye API à votre application. Vous pouvez aussi commencer dans le playground, sans écrire de code.

Démarrage rapide

Faites un premier appel en trois étapes.

  1. 1
    Créez un compte et une organisation

    L’onboarding prépare automatiquement votre espace.

  2. 2
    Générez une clé de test

    Copiez-la immédiatement : elle ne sera affichée qu’une fois.

  3. 3
    Appelez un endpoint

    Remplacez VOTRE_CLE_API dans l’exemple ci-dessous.

curl "https://neopay-api-staging.onrender.com/v1/companies/search?q=neo&limit=10" \
  -H "Authorization: Bearer VOTRE_CLE_API"

Authentification

Ajoutez votre clé à chaque requête.

Toutes les routes /v1 utilisent une authentification Bearer. Une clé de test commence par nd_test_ et une clé de production par nd_live_.

const response = await fetch(
  "https://neopay-api-staging.onrender.com/v1/companies/search?q=neo",
  { headers: { Authorization: "Bearer VOTRE_CLE_API" } }
);

const result = await response.json();

Référence

Neuf services, répartis en trois familles.

Entreprises

Rechercher et consulter les entreprises et leurs établissements.

GET/v1/companies/searchRechercher des entreprises
GET/v1/companies/{siren}Consulter une entreprise
GET/v1/companies/{siren}/establishmentsLister les établissements
GET/v1/companies/{siren}/summaryObtenir une synthèse

Adresses

Rechercher, autocompléter ou géolocaliser une adresse.

GET/v1/addresses/searchRechercher une adresse
GET/v1/addresses/autocompleteAutocompléter une saisie
GET/v1/addresses/reverseFaire un géocodage inverse

Immobilier

Explorer les transactions et les indicateurs d’un marché local.

GET/v1/properties/transactionsRechercher des transactions
GET/v1/properties/market-summaryObtenir un résumé du marché

Format commun

Des réponses prévisibles.

Une réponse réussie contient toujours success, data et meta. Les listes ajoutent un bloc pagination.

400Paramètres incorrects
401Clé invalide ou expirée
404Donnée introuvable
429Limite atteinte
503Source indisponible
504Source trop lente

Sécurité

Gardez votre clé secrète.

  • Conservez la clé dans une variable d’environnement.
  • Ne l’ajoutez jamais dans un dépôt, une capture ou un message public.
  • Utilisez une clé différente pour chaque application.
  • Révoquez immédiatement une clé qui pourrait être compromise.