Integraciones

Consultar un catálogo para integraciones

GET/integraciones/catalogos/:catalogo/:token

Consulta uno de los catálogos disponibles para una integración. catalogo es numérico. Los resultados pertenecen a la empresa asociada al token, excepto el catálogo de países, que es general. Devuelve un arreglo sin paginación. Conserva la escritura de los campos: varios nombres se devuelven en mayúsculas.

catalogo	Contenido	Campos
1	Fases de prospectos	TK, FASE
2	Orígenes	TK, ORIGEN, ORIGIN
3	Fases de clientes	TK, FASE
4	Países	IDPAIS, PAIS
5	Etiquetas	TK, ETIQUETA
6	Campos adicionales del esquema anterior	IDCAMPO, NOMBRE
7	Campos personalizados de prospectos y clientes	key, type, label, required, help_text, placeholder

También puedes usar el alias /integraciones/catalogos/:catalogo y enviar el token de integración en el encabezado token. Usa únicamente los valores de catálogo del 1 al 7.

Rutas alternativas

/integraciones/catalogos/:catalogo

Parámetros

Nombre	Tipo	Validación	Descripción
`catalogo`	int		URL (obligatorio): Número de catálogo, del 1 al 7; consulta la tabla de opciones.
`token`	String	Requerido	URL (obligatorio): Token completo de la integración, incluido su prefijo si lo tiene. Conserva el valor proporcionado por Upnify.

Respuesta

Nombre	Tipo	Descripción
`TK`	String	Identificador de fase, origen o etiqueta; aparece en los catálogos 1, 2, 3 y 5.
`FASE`	String	Nombre de la fase en los catálogos 1 y 3.
`ORIGEN`	String	Nombre del origen en el catálogo 2.
`ORIGIN`	String	Mismo valor que ORIGEN en el catálogo 2.
`IDPAIS`	String	Código de país en el catálogo 4.
`PAIS`	String	Nombre del país en el catálogo 4.
`ETIQUETA`	String	Nombre de la etiqueta en el catálogo 5.
`IDCAMPO`	String	Identificador de campo del catálogo 6, por ejemplo CAMPO1.
`NOMBRE`	String	Nombre del campo del catálogo 6.
`key`	String	Clave del campo personalizado, con prefijo cp., en el catálogo 7.
`type`	String	Valor unicode en el catálogo 7; no describe por sí solo todas las validaciones del campo.
`label`	String	Etiqueta del campo en el catálogo 7.
`required`	Integer	Valor 0 en el catálogo 7.
`help_text`	String	Descripción del campo en el catálogo 7; puede ser null.
`placeholder`	String	Texto de ayuda del campo en el catálogo 7; puede ser null.

Solicitud

curl --request GET \
  --url https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001 \
  --header 'Accept: application/json'async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001", {
    method: "GET",
    headers: {"Accept": "application/json"}
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);// Node.js 18 o posterior.
async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001", {
    method: "GET",
    headers: {"Accept": "application/json"}
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);import json
import requests

response = requests.request(
    "GET",
    "https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001",
    headers={'Accept': 'application/json'},
    timeout=30,
)
response.raise_for_status()
data = response.json() if response.text else None
# Usa data en tu aplicación sin exponer tokens o datos personales.
print("Estado HTTP:", response.status_code)package main

import (
  "fmt"
  "io"
  "net/http"
  "time"
)

func main() {
  request, err := http.NewRequest("GET", "https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001", nil)
  if err != nil { panic(err) }
  request.Header.Set("Accept", "application/json")
  client := &http.Client{Timeout: 30 * time.Second}
  response, err := client.Do(request)
  if err != nil { panic(err) }
  defer response.Body.Close()
  data, err := io.ReadAll(response.Body)
  if err != nil { panic(err) }
  if response.StatusCode < 200 || response.StatusCode >= 300 {
    panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data))
  }
  fmt.Println("Estado HTTP:", response.StatusCode)
}using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.upnify.com/integraciones/catalogos/2/P01AP00000000-0000-4000-8000-000000000001");
request.Headers.Add("Accept", "application/json");
using var response = await client.SendAsync(request);
var data = await response.Content.ReadAsStringAsync();
response.EnsureSuccessStatusCode();
Console.WriteLine($"Estado HTTP: {(int)response.StatusCode}");

curl --request GET \
  --url https://api.upnify.com/integraciones/catalogos/2 \
  --header 'Accept: application/json' \
  --header 'token: P01AP00000000-0000-4000-8000-000000000001'async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/catalogos/2", {
    method: "GET",
    headers: {"Accept": "application/json", "token": "P01AP00000000-0000-4000-8000-000000000001"}
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);// Node.js 18 o posterior.
async function ejecutar() {
  const response = await fetch("https://api.upnify.com/integraciones/catalogos/2", {
    method: "GET",
    headers: {"Accept": "application/json", "token": "P01AP00000000-0000-4000-8000-000000000001"}
  });
  const text = await response.text();
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
  const data = text ? JSON.parse(text) : null;
  // Usa data en tu aplicación sin exponer tokens o datos personales.
  console.log("Estado HTTP:", response.status);
}

ejecutar().catch(console.error);import json
import requests

response = requests.request(
    "GET",
    "https://api.upnify.com/integraciones/catalogos/2",
    headers={'Accept': 'application/json', 'token': 'P01AP00000000-0000-4000-8000-000000000001'},
    timeout=30,
)
response.raise_for_status()
data = response.json() if response.text else None
# Usa data en tu aplicación sin exponer tokens o datos personales.
print("Estado HTTP:", response.status_code)package main

import (
  "fmt"
  "io"
  "net/http"
  "time"
)

func main() {
  request, err := http.NewRequest("GET", "https://api.upnify.com/integraciones/catalogos/2", nil)
  if err != nil { panic(err) }
  request.Header.Set("Accept", "application/json")
  request.Header.Set("token", "P01AP00000000-0000-4000-8000-000000000001")
  client := &http.Client{Timeout: 30 * time.Second}
  response, err := client.Do(request)
  if err != nil { panic(err) }
  defer response.Body.Close()
  data, err := io.ReadAll(response.Body)
  if err != nil { panic(err) }
  if response.StatusCode < 200 || response.StatusCode >= 300 {
    panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data))
  }
  fmt.Println("Estado HTTP:", response.StatusCode)
}using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.upnify.com/integraciones/catalogos/2");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("token", "P01AP00000000-0000-4000-8000-000000000001");
using var response = await client.SendAsync(request);
var data = await response.Content.ReadAsStringAsync();
response.EnsureSuccessStatusCode();
Console.WriteLine($"Estado HTTP: {(int)response.StatusCode}");

Respuesta

[
  {
    "TK": "00000000-0000-4000-8000-000000000001",
    "ORIGEN": "Formulario web",
    "ORIGIN": "Formulario web"
  }
]

[
  {
    "key": "cp.interes",
    "type": "unicode",
    "label": "Interés",
    "required": 0,
    "help_text": "Producto de interés",
    "placeholder": "Producto de interés"
  }
]

Consultar un catálogo para integraciones

Rutas alternativas

Parámetros

Respuesta

Solicitud

Consultar orígenes

Consultar orígenes con token en el encabezado

Respuesta

Orígenes disponibles (HTTP 200)

Campos personalizados: ejemplo de catálogo 7