B2B API — Buscar empresas (REST)

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para buscar empresas y obtener una lista de resultados coincidentes.

Documentación relacionada de la B2B API RESTful:

Solicitud GET

Solo CompanyName o CompanyNumber

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

Simplemente reemplace los elementos entre llaves con su información.

Parámetro Descripción Obligatorio/Opcional
SERVER_ADDRESS Dirección del servidor DQE que procesará los datos. Obligatorio
VERSION Versión de la API. Ejemplo: v1 Obligatorio
Licence Número asignado como su código de licencia. Obligatorio
CompanyName o CompanyNumber Entrada del usuario: nombre de la empresa o número de empresa. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Nombre de empresa y código postal

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parámetro Descripción Obligatorio/Opcional
SERVER_ADDRESS Dirección del servidor DQE que procesará los datos. Obligatorio
VERSION Versión de la API. Ejemplo: v1 Obligatorio
Licence Número asignado como su código de licencia. Obligatorio
CompanyName Entrada del usuario: nombre de la empresa. Obligatorio
PostalCode Código postal. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Solo dirección postal

GET https://{SERVER_ADDRESS}/{VERSION}/checkname/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FILTER}
Parámetro Descripción Obligatorio/Opcional
SERVER_ADDRESS Dirección del servidor DQE que procesará los datos. Obligatorio
VERSION Versión de la API. Ejemplo: v1 Obligatorio
Licence Número asignado como su código de licencia. Obligatorio
Address Tipo de vía y nombre de la calle de la dirección comercial. Obligatorio
PostalCode Código postal. Obligatorio
City Nombre de la ciudad. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Solicitud POST

Añada los parámetros siguientes en el cuerpo usando x-www-form-urlencoded.

Solo CompanyName o CompanyNumber

POST https://{SERVER_ADDRESS}/{VERSION}/lookupcname/
Parámetro Descripción Obligatorio/Opcional
Licence Número asignado como su código de licencia. Obligatorio
CompanyName o CompanyNumber Entrada del usuario: nombre de la empresa o número de empresa. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Nombre de empresa y código postal

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parámetro Descripción Obligatorio/Opcional
Licence Número asignado como su código de licencia. Obligatorio
CompanyName Entrada del usuario: nombre de la empresa. Obligatorio
PostalCode Código postal. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Solo dirección postal

POST https://{SERVER_ADDRESS}/{VERSION}/checkname/
Parámetro Descripción Obligatorio/Opcional
Licence Número asignado como su código de licencia. Obligatorio
Address Tipo de vía y nombre de la calle de la dirección comercial. Obligatorio
PostalCode Código postal. Obligatorio
City Nombre de la ciudad. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Filter Filtro de estado de la empresa. Se pueden separar varios valores con comas.
1 — Abierta difusible
2 — Cerrada difusible
3 — Cerrada antigua (+3 años) difusible
4 — No difusible
5 — RNA
Ejemplo: Filter=1,2 		Opcional. Valor por defecto: 1
NAF25 Obtener o no el nuevo valor del Sic Code en Francia: True / False Opcional. Valor por defecto: False

Respuesta

Éxito

La respuesta JSON es un diccionario (objeto) que contiene dos claves principales:

  • Found: número entero que indica la cantidad de empresas encontradas.
  • Companies: lista que contiene uno o más objetos de empresa.

Cada objeto de empresa contiene las siguientes claves:

Clave Descripción Tipo / Restricciones
City Ciudad donde se encuentra la empresa. Cadena, hasta 100 caracteres
L1Standardized Línea 1 de dirección estandarizada, a menudo la razón social. Cadena, hasta 255 caracteres
MainCompanyFlag Indica si este es el registro principal de la empresa. 1: sí; 0: no. Cadena o entero
CompanyStatus Estado administrativo de la empresa. 0: activa. Cadena o entero
VatNumber Número de IVA intracomunitario.
Este campo está vacío si la empresa no está sujeta a IVA.		 Cadena
SearchRef Referencia interna que vincula el resultado con la solicitud de búsqueda. Cadena
PhoneNumber Número de teléfono de la empresa. Cadena
LegalStructure Forma jurídica de la empresa. Array de objetos: { Value, Label }
L2Standardized Línea 2 de dirección estandarizada. Cadena
CompanyNumber Conjunto de identificadores legales, como SIREN y NIC. Array de objetos: { Type, Value }
CompanyCName Nombre comercial o razón social completa. Cadena
IncorporationDate Fecha de creación de la empresa. Cadena, YYYY-MM-DD
StaffCount Número o rango de empleados declarado. Cadena
Classification Códigos de clasificación de la actividad económica. Array de objetos: { Type, Value, Label }
L5Standardized Línea 5 de dirección estandarizada. Cadena
DissolutionDate Fecha en la que la empresa dejó de existir, si aplica. Cadena, YYYY-MM-DD
L4Standardized Línea de dirección estandarizada que contiene calle y número. Cadena
PosCod Código postal. Cadena, hasta 10 caracteres
TurnOver Facturación o ingresos declarados. Cadena o número

Ejemplo:

{
  "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": ""
    }
  ]
}

Error

Tipo de error Solicitud Tipo de respuesta
Falta el parámetro Licence https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA {"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Parámetro Licence vacío https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=FRA&Licence= {"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Número de licencia incorrecto 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"}
Falta el parámetro CompanyName https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Falta el parámetro Country https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "Country", "error": "bad request"}
Parámetro CompanyName vacío https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=&Country=FRA&Licence={LICENSE} {"status": 400, "message": "Missing parameters", "details": "CompanyName", "error": "bad request"}
Parámetro Country vacío https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName=dqe%20paris&Country=&Licence={LICENSE} {"Found":0,"Companies":[]}

Documentación Swagger

Ver también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0