B2B API — Unternehmen suchen (REST)

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um nach Unternehmen zu suchen und eine Liste passender Ergebnisse zurückzugeben.

Verwandte Restful B2B API-Dokumentation:

GET-Anfrage

Nur CompanyName oder CompanyNumber

GET https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}

Ersetzen Sie die Werte in geschweiften Klammern einfach durch Ihre Informationen.

Parameter Beschreibung Pflicht/Optional
SERVER_ADDRESS Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
VERSION Version der API. Beispiel: v1 Pflicht
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
CompanyName oder CompanyNumber Nutzereingabe: Firmenname oder Unternehmensnummer. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

Firmenname und Postleitzahl

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parameter Beschreibung Pflicht/Optional
SERVER_ADDRESS Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
VERSION Version der API. Beispiel: v1 Pflicht
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
CompanyName Nutzereingabe: Firmenname. Pflicht
PostalCode Postleitzahl. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

Nur Postadresse

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parameter Beschreibung Pflicht/Optional
SERVER_ADDRESS Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
VERSION Version der API. Beispiel: v1 Pflicht
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
Address Straßentyp und Straßenname der Geschäftsadresse. Pflicht
PostalCode Postleitzahl. Pflicht
City Stadtname. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

POST-Anfrage

Fügen Sie die unten stehenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu.

Nur CompanyName oder CompanyNumber

POST https://{SERVER_ADDRESS}/{VERSION}/lookupcname/
Parameter Beschreibung Pflicht/Optional
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
CompanyName oder CompanyNumber Nutzereingabe: Firmenname oder Unternehmensnummer. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

Firmenname und Postleitzahl

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parameter Beschreibung Pflicht/Optional
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
CompanyName Nutzereingabe: Firmenname. Pflicht
PostalCode Postleitzahl. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

Nur Postadresse

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parameter Beschreibung Pflicht/Optional
Licence Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
Address Straßentyp und Straßenname der Geschäftsadresse. Pflicht
PostalCode Postleitzahl. Pflicht
City Stadtname. Pflicht
Country ISO-3-Buchstaben-Ländercode. Pflicht
Filter Filter für den Unternehmensstatus. Mehrere Werte können durch Kommas getrennt werden.
1 — Geöffnet, veröffentlichungsfähig
2 — Geschlossen, veröffentlichungsfähig
3 — Geschlossen, alt (+3 Jahre), veröffentlichungsfähig
4 — Nicht veröffentlichungsfähig
5 — RNA
Beispiel: Filter=1,2 		Optional. Standardwert: 1
NAF25 Ruft den neuen Wert des Sic-Codes in Frankreich ab oder nicht: True / False Optional. Standardwert: False

Antwort

Erfolg

Die JSON-Antwort ist ein Dictionary (Objekt), das zwei Hauptschlüssel enthält:

  • Found: Ganzzahl, die die Anzahl der gefundenen Unternehmen angibt.
  • Companies: Liste mit einem oder mehreren Unternehmensobjekten.

Jedes Unternehmensobjekt enthält die folgenden Schlüssel:

Schlüssel Beschreibung Typ / Einschränkungen
City Stadt, in der sich das Unternehmen befindet. String, bis zu 100 Zeichen
L1Standardized Standardisierte Adresszeile 1, häufig der eingetragene Name. String, bis zu 255 Zeichen
MainCompanyFlag Gibt an, ob es sich um den Hauptdatensatz des Unternehmens handelt. 1: ja; 0: nein. String oder Integer
CompanyStatus Administrativer Status des Unternehmens. 0: aktiv. String oder Integer
VatNumber Innergemeinschaftliche USt-IdNr.
Dieses Feld ist leer, wenn das Unternehmen nicht umsatzsteuerpflichtig ist.		 String
SearchRef Interne Referenz, die das Ergebnis mit der Suchanfrage verknüpft. String
PhoneNumber Telefonnummer des Unternehmens. String
LegalStructure Rechtsform des Unternehmens. Array von Objekten: { Value, Label }
L2Standardized Standardisierte Adresszeile 2. String
CompanyNumber Satz rechtlicher Kennungen, wie SIREN und NIC. Array von Objekten: { Type, Value }
CompanyCName Handelsname oder vollständiger Firmenname. String
IncorporationDate Gründungsdatum des Unternehmens. String, YYYY-MM-DD
StaffCount Angegebene Mitarbeiterzahl oder -bereich. String
Classification Klassifizierungscodes der Geschäftstätigkeit. Array von Objekten: { Type, Value, Label }
L5Standardized Standardisierte Adresszeile 5. String
DissolutionDate Datum, an dem das Unternehmen aufgelöst wurde, sofern zutreffend. String, YYYY-MM-DD
L4Standardized Standardisierte Adresszeile mit Straße und Hausnummer. String
PosCod Postleitzahl. String, bis zu 10 Zeichen
TurnOver Gemeldeter Umsatz oder Erlös. String oder Zahl

Beispiel:

{
  "Found": 1,
  "Companies": [
    {
      "City": "PARIS",
      "L1Standardized": "DQE-SOFTWARE",
      "MainCompanyFlag": "0",
      "CompanyStatus": "0",
      "VatNumber": "FR 85 504403387",
      "SearchRef": "_33170132",
      "PhoneNumber": "",
      "LegalStructure": [
        {
          "Value": "5710",
          "Label": "SAS, société par actions simplifiée"
        }
      ],
      "L2Standardized": "",
      "CompanyNumber": [
        {
          "Type": "Siren",
          "Value": "504xxxxxx"
        },
        {
          "Type": "Nic",
          "Value": "xxxxx"
        }
      ],
      "CompanyCName": "DQE SOFTWARE",
      "IncorporationDate": "2014-11-17",
      "StaffCount": "Non-employer",
      "Classification": [
        {
          "Type": "NAF08",
          "Value": "5829C",
          "Label": "Edition de logiciels applicatifs"
        }
      ],
      "L5Standardized": "",
      "DissolutionDate": "2018-01-31",
      "L4Standardized": "42 RUE FORTUNY",
      "PosCod": "75017",
      "TurnOver": ""
    }
  ]
}

Fehler

Fehlertyp Anfrage Antworttyp
Fehlender Parameter Licence https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA {"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Leerer Parameter Licence https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence= {"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Falsche Lizenznummer https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence={WRONG LICENSE} {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{WRONG LICENSE}", "error": "unauthorized_client"}
Fehlender Parameter CompanyName https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Fehlender Parameter Country https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"}
Leerer Parameter CompanyName https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=&Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Leerer Parameter Country https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=&Licence={LICENSE} {"Found":0,"Companies":[]}

Swagger-Dokumentation

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich