Introducción

La API de ubicaciones permite a los socios comerciales de Haulmer obtener información detallada sobre las ubicaciones físicas donde están desplegados sus terminales de pago. Esta API proporciona datos de ubicación estructurados incluyendo dirección completa, comuna, ciudad y región.

El endpoint aborda:

• Gestión de ubicaciones: Centraliza la información de todas las ubicaciones de dispositivos
• Análisis geográfico: Facilita información pata reportes y análisis por ubicación geográfica

Esta pensando para casos de uso como:

• Listado de sucursales: Obtener todas las ubicaciones activas de una cuenta
• Análisis geográfico: Estudios de distribución por región o comuna

URL base: https://integrations.payment.haulmer.com/

Autenticación: Todas las solicitudes a esta API requieren autenticación mediante una API Key enviado en el encabezado X-API-Key

Formato de Datos: JSON

Autenticación

Todas las solicitudes requieren autenticación mediante una clave API proporcionada por Haulmer (para conocer como obtenerlo, refiérase al siguiente enlace https://developers.tuu.cl/docs/generaci%C3%B3n-de-api-key-en-espacio-de-trabajo).

Endpoints

GET /DeviceLocation/locations

Obtiene todas las ubicaciones únicas asociadas a la cuenta del usuario autenticado.

Parámetros de consulta (Query Parameters):

Este endpoint no requiere parámetros en el cuerpo de la solicitud. La autenticación se realiza a través del header y la cuenta se identifica automáticamente.

Ejemplo de solicitud (cURL):

curl -X GET "https://integrations.payment.haulmer.com/DeviceLocation/locations" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Respuesta exitosa (200 OK):

Respuesta con ubicaciones

• id: Identificador único de la ubicación.
• street: Nombre de la calle o avenida.
• number: Número de la dirección.
• commune: Comuna donde se ubica la sucursal.
• city: Ciudad donde se ubica la sucursal.
• region: Región donde se ubica la sucursal.

{
    "metadata": {
        "code": "L-00",
        "message": "Success"
    },
    "data": [
        {
            "id": 3,
            "street": "111",
            "number": "Calle falsa 666",
            "commune": "Concón",
            "city": "Concón - Fuerte Aguayo",
            "region": "Valparaíso"
        },
        {
            "id": 12215,
            "street": "",
            "number": "Avenida Siempre Haulmer 123",
            "commune": "San Fernando",
            "city": "San Fernando",
            "region": "Libertador Gral. Bernardo O’Higgins"
        }
    ],
    "pagination": null
}

Respuesta sin ubicaciones

{
  "metadata": {
    "code": "L-01",
    "message": "No locations found for this account"
  },
  "data": [],
  "pagination": null
}

Códigos de estados