Estándares

Bienvenido, aquí encontrarás los estándares que estamos utilizando en el API de SalesUp!® CRM.

Bienvenida

Te damos la más cordial bienvenida al API de SalesUp!® A continuación mencionaremos los estándares que estamos utilizando en gran parte de las llamadas del API.

Camel Case

Es un tipo de escritura que se aplica a palabras compuestas o frases que no se separan por un espacio. Es una convención de nomenclatura para crear un solo vocablo compuesto por varias palabras y cada una de ellas comienza con mayúscula para facilitar tu lectura.

Existen dos tipos de CamelCase:

  • UpperCamelCase, se refiere a que todas las palabras comienzan con mayúscula. EjemploDeUpperCamelCase.
  • lowerCamelCase, es similar a la anterior con la excepción de que la primera letra es minúscula. ejemploDeLowerCamelCase

En el API utilizamos la variante llamada lowerCamelCase, la cual tiene las siguientes prácticas:

  • La primera letra siempre va en minúscula.
  • La palabra nunca termina en mayúscula. Ej: filosofoA
  • Nunca van juntas dos letras mayúsculas. Ej: ventAS
  • No se utilizan caracteres de puntuación como punto, guión medio o guión bajo (.-_)
  • No se utilizan caracteres acentuados (áéíóú)

Paginación y límite de registros

En la mayoría de las llamadas en donde existen listados (normalmente GET), el API por defecto mandará los primeros 50 registros si no se especifica ningún parámetro adicional. Sin embargo, es posible traer un número específico iniciando en una página específica, utilizando los siguientes parámetros:

Parámetro Descripción
cantidadRegistros Indica el número de registros que se desean descargar en total.
pagina Indica en que página se desea comenzar. Por ejemplo, si la cantidadRegistros=10 y pagina=2, los registros que traerá el API serán del 11 al 20.

El siguiente ejemplo muestra como traer múltiples registros de distintas páginas:

Periodos

En ciertas secciones del API, será necesario incluir un parámetro de tipo PERIODO, para poder definir un rango de tiempo. Los valores que reconoce el API son los siguientes:

Parámetro Código y descripción
periodo 0 - Especificar periodo.
1 - Hoy.
2 - Ayer.
3 - Semana actual.
4 - Semana pasada.
5 - Mes actual.
6 - Mes pasado.
8 - Año actual.
10 - Año pasado.
11 - Quincena actual.
12 - Quincena pasada.
13 - Semestre actual.
14 - Semestre pasado.
15 - Cuatrimestre actual.
16 - Cuatrimestre pasado.
17 - Trimestre actual.
18 - Trimestre pasado.
19 - Bimestre actual.
20 - Bimestre pasado.

Cuando sea necesario especificar un periodo, el parámetro "periodo" se envía con un cero (0), pero además es necesario definir las fechas de inicio y fin del periodo. Esto se logra mandando los parámetros fechaInicio y fechaFin con un formato de fecha tipo datetime.

El siguiente ejemplo corresponde a un reporte, y en el se hace uso del periodo cero (0) como parte de los filtros.