pappers_api

v2.3.0

Published

2 years ago

Client js pour l'API pappers

Downloads

0High
0Medium
0Low

anisdhiyaeddine

pappers api client pappers_api entreprise

pappers_api

PappersApi - JavaScript client for pappers_api L'API de Pappers vous permet de récupérer des informations et documents sur les entreprises françaises à partir de leur numéro SIREN ou SIRET.

Vous devez indiquer votre clé d'API dans les requêtes, en utilisant le paramètre api_token.

L'URL d'accès à l'API est https://api.pappers.fr/v2/

Lien vers la documentation de la V1 : https://www.pappers.fr/api/documentation/v1

L'historique des modifications (changelog) est accessible à l'url suivante : https://www.pappers.fr/api/changelog

This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.3.0
Package version: 2.3.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install pappers_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your pappers_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PappersApi = require('pappers_api');


var api = new PappersApi.ComptesAnnuelsApi()
var apiToken = votre_clé_ici; // {String} Clé d'utilisation de l'API
var opts = {
  'siren': 443061841, // {String} SIREN de l'entreprise
  'annee': 2016,2017,2018 // {String} Année de cloture des comptes souhaités. Il est possible d'indiquer plusieurs années en les séparant par des virgules. Si le paramètre n'est pas fourni, toutes les années disponibles seront retournées.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.comptesAnnuels(apiToken, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.pappers.fr/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PappersApi.ComptesAnnuelsApi | comptesAnnuels | GET /entreprise/comptes | Récupère les comptes annuels publiés d'une entreprise. PappersApi.DocumentsApi | documentTelechargement | GET /document/telechargement | Télécharge un document PDF ou XLSX à partir de son token. PappersApi.FicheEntrepriseApi | entreprise | GET /entreprise | Récupère l'ensemble des informations disponibles sur une entreprise. PappersApi.RechercheApi | recherche | GET /recherche | Recherche les entreprises qui correspondent à des critères. PappersApi.RechercheApi | rechercheBeneficiaires | GET /recherche-beneficiaires | Recherche les bénéficiaires effectifs qui correspondent à des critères. PappersApi.RechercheApi | rechercheDirigeants | GET /recherche-dirigeants | Recherche les dirigeants qui correspondent à des critères. PappersApi.RechercheApi | rechercheDocuments | GET /recherche-documents | Recherche les documents qui correspondent à des critères. PappersApi.RechercheApi | recherchePublications | GET /recherche-publications | Recherche les publications BODACC qui correspondent à des critères. PappersApi.SuggestionsAutocompleteApi | suggestions | GET /suggestions | Recherche les entreprises qui correspondent à un début de recherche textuelle (type autocomplete).

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

pappers_api

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization