Empresas

Esta API te permitirá crear, eliminar y actualizar tus empresas. También podrás obtener empresas individualmente o una lista paginada con todas tus empresas.

Relacionado

Guía rápida > Crea una empresa

Endpoints

POST
/v1/companiesGET
/v1/companies/:idPOST
/v1/companies/:idDELETE
/v1/companies/:idGET
/v2/apps/:clientId/companies

Crear empresa

Si la empresa ya se encuentra registrada en la plataforma (el correo electrónico ya existe), se creará una relación sin modificar ningún otro dato.

Los atributos opcionales que no se hayan facilitado los pediremos posteriormente.

Parámetro	Descripción
name	Nombre
email	Correo electrónico
nif _opcional	NIF, VAT, TAX ID...
image _opcional	Link del avatar
country _opcional	País en estándar ISO 3166-2
province _opcional	Provincia / Estado en estándar ISO 3166-2
city _opcional	Ciudad
employees _opcional	Número de empleados
sector _opcional	Sector
firstname _opcional	Nombre de la persona de contacto
lastname _opcional	Apellidos de la persona de contacto

Resultado

Devolverá el identificador único si la creación de la empresa ha tenido éxito. Puede devolver un error si hay parámetros inválidos o si el correo electrónico ya existe y le pertenece a un profesional.

Terminal
$curl URL_API/api/v1/companies \>  -u CLIENT_SECRET: \>  -d "name"="Empresa de prueba" \>  -d "email"="company@danchiano.com" \>  -d "nif"="989898Z" \>  -d "image"="https://d347nhcygwz59.cloudfront.net/uploads/info-logo.png" \>  -d "country"="ES" \>  -d "province"="B" \>  -d "city"="Barcelona" \>  -d "employees"=1 \>  -d "sector"=71 \>  -d "firstname"="Nombre del contacto" \>  -d "lastname"="Apellidos del contacto"

JSON
 {   "created": "2024-09-02",   "companyId": APPLICANT_ID }

Editar empresa

Actualiza la empresa especificada guardando los valores de los parámetros enviados. Cualquier parámetro no enviado no será actualizado.

Parámetro	Descripción
name _opcional	Nombre
email _opcional	Correo electrónico
nif _opcional	NIF, VAT, TAX ID...
image _opcional	Link del avatar
country _opcional	País en estándar ISO 3166-2
province _opcional	Provincia / Estado en estándar ISO 3166-2
city _opcional	Ciudad
employees _opcional	Número de empleados
sector _opcional	Sector
firstname _opcional	Nombre de la persona de contacto
lastname _opcional	Apellidos de la persona de contacto

Terminal
$curl URL_API/api/v1/companies \>  -u CLIENT_SECRET: \>  -d "name"="Empresa de prueba editada"

Obtener empresa

Obtén los detalles de una empresa existente. Solo necesitarás facilitar el id de la empresa que obtuvo al crearla.

Parámetro
No hay parámetros

Resultado

Si el identificador es válido devolverá los datos de la empresa y los puestos jobs que ha creado.

Terminal
$curl URL_API/api/v1/companies/COMPANY_ID \>  -u CLIENT_SECRET:

JSON
   {     "address": null,     "city": null,     "companyId": COMPANY_ID,     "country": null,     "cp": null,     "created": "2021-06-10 16:02:17.909615+00:00",     "email": "testcompany@danchiano.com",     "employees": 3,     "firstname": null,     "jobs": [       {         "jobId": 61094,         "standard": false,         "test": true       }     ],     "lastname": null,     "name": "Empresa de prueba editada",     "nif": "123456",     "phone": null,     "province": null,     "sector": null   }

Eliminar empresa

Elimina la empresa especificada de la aplicación.

Parámetro
No hay parámetros

Terminal
$curl URL_API/api/v1/companies/COMPANY_ID \>  -u CLIENT_SECRET: \>  -X DELETE

curl
 1200 OK

Obtener todas tus empresas

Obtén una lista paginada con todas tus empresas.

Parámetro	Descripción
p _Opcional	Número de página

Resultado

Devolverá solo datos básicos de tus empresas.

Terminal
$curl URL_API/api/v2/apps/CLIENT_ID/companies?p=0 \>  -u CLIENT_SECRET:

JSON
   {     "pagination": {       "count": 3,       "currentPage": 0,       "totalPages": 1     },     "list": [       {         "id": 1328778,         "name": "Company renamed",         "email": "testcompany@danchiano.com",         "created": "2021-06-10T16:02:17.909Z",         "accessed": "2021-06-10T16:02:20.225Z",         "fullyRegistered": false,         "jobs": 1       },       {         "id": 1036018,         "name": "Coorve",         "email": "guillermo@coorve.com",         "created": "2020-11-09T23:00:00.000Z",         "accessed": "2020-11-09T23:00:00.000Z",         "fullyRegistered": true,         "jobs": 1       },       {         "id": 5,         "name": "PymeLegal",         "email": "pyme@legal.com",         "created": "2017-05-12T22:00:00.000Z",         "accessed": "2021-05-12T15:06:35.473Z",         "fullyRegistered": true,         "jobs": 43       }     ]   }

Última actualización el 4 ene 2020.