Get Services
GET
/servicesObtener listado de empresas de servicios disponibles
Objetivo
El endpoint /services tendrá como objetivo devolver el listado completo de empresas de servicios activas integradas a nuestra plataforma. Es posible usar filtros para especificar que solo se devuelvan los servicios que cuentan con una característica en particular.
Request
Headers
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-authorization-token | String | Sí | Token de autorización obtenido del login. |
x-api-key | String | Sí | API Key proporcionada para el acceso a la API. |
Query Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
page | Number | No | Número de página para la paginación (default: 1). |
limit | Number | No | Número máximo de resultados a retornar por página. |
active | Boolean | No | Filtrar por empresas activas (true) o inactivas (false). |
searchCompany | String | No | Término de búsqueda para filtrar empresas por nombre o código. |
tag | String | No | Etiqueta específica para filtrar empresas por categoría o tipo de servicio. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
companyCode | String | Código de compañía. |
companyName | String | Nombre de compañía. |
companyType | String | Descripción breve de la compañia. |
companyLogo | String | Identificador de la empresa. |
tags | String[] | Tags identificadores de compañías, por ejemplo, el rubro. |
modalities | Object[] | Modalidades para la consulta de deuda. |
tx | String | Identificador de la transacción interno de tapi. |
mainTx | String | Identificador de la transacción interno de tapi. |
Response Examples
200 OK
Consideraciones
- Los resultados están paginados por defecto con un límite de 50 empresas por página
- El campo 'logo' puede ser null si la empresa no tiene logo disponible
- Los campos requeridos para cada empresa pueden variar según el tipo de servicio
- La disponibilidad del servicio puede cambiar según la empresa y el país
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \ --url https://companies.homo.tapila.cloud/services?page=1&limit=10&active=true&searchCompany=edenor&tag=utilities \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE'