Introducción

El objetivo de esta guía es mostrarle los primeros pasos con los cuales usted podrá realizar una conexión básica hacia SYSCOM y solicitar información de cualquier recurso.

El API SYSCOM le permitirá buscar y filtrar productos, crear y consultar listas de productos, y obtener información actualizada de precios y promociones en tiempo real.

Características generales

• URI Base: https://developers.syscom.mx/api/v1/.
• El límite de llamadas por cliente es de 60 peticiones por minuto.
• Las respuestas son enviadas en formato JSON.

1. Token de acceso

El servicio utiliza un esquema REST con autenticación a través del protocolo OAuth 2.0.

El primer paso para cualquier solicitud, es generar un usuario y contraseña, la cual se adquiere haciendo Login utilizando el acceso de la cuenta regular en SYSCOM.

Una vez ingresado, será necesario crear una nueva aplicación, ingresando el nombre y dando como respuesta un ID Client y un Secret Client.

Credenciales

• ID Client: Identificador único del cliente para realizar un movimiento.
• Secret Client: Contraseña de acceso del cliente.

Para hacer llamadas al API, primero debe obtener su id y contraseña de aplicación. Estas credenciales se usan para crear un token de acceso, que le permitirá hacer llamadas a las rutas protegidas.

Obtenga su token de acceso

Una vez obtenidas las credenciales se puede generar un token de acceso. Para esto se hace una llamada POST a la ruta https://developers.syscom.mx/oauth/token.

  curl --request POST --url https://developers.syscom.mx/oauth/token
  -H 'Content-Type: application/x-www-form-urlencoded'
  --data 'client_id=ID_CLIENTE&client_secret=SECRETO_CLIENTE&grant_type=client_credentials'

La respuesta consta un objeto JSON con 3 propiedades: tipo de token, token y tiempo de expiración. Por defecto los tokens de acceso tienen una vigencia de 365 días.

{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "VALOR_DEL_TOKEN"
}

2. Solicitar un recurso

Una vez obtenido el VALOR_DEL_TOKEN, éste se debe agregar a todas las peticiones en la cabecera Authorization con el siguiente valor:

    curl "https://developers.syscom.mx/api/v1/RECURSO"
    -H "Authorization: Bearer VALOR_DEL_TOKEN"

Primera petición

A continuación se muestra un ejemplo de petición y respuesta correcta en la ruta de categorías, que incluye la cabecera de autorización con un token válido.

Para más recursos, visite nuestra documentación.

Petición

curl --request GET \
  --url https://developers.syscom.mx/api/v1/categorias \
  --header 'Authorization: Bearer  VALOR_DEL_TOKEN'

Respuesta

[
    {
        "id": "22",
        "nombre": "Videovigilancia",
        "nivel": 1
    },
    {
        "id": "25",
        "nombre": "Radiocomunicación",
        "nivel": 1
    },
    {
        "id": "26",
        "nombre": "Redes",
        "nivel": 1
    },
    {
        "id": "27",
        "nombre": "GPS, Luces de Emergencia    y Transporte",
        "nivel": 1
    },
    {
        "id": "30",
        "nombre": "Energía",
        "nivel": 1
    },
    {
        "id": "32",
        "nombre": "Automatización  e Intrusión",
        "nivel": 1
    },
    {
        "id": "37",
        "nombre": "Control  de Acceso ",
        "nivel": 1
    },
    {
        "id": "38",
        "nombre": "Detección  de Fuego",
        "nivel": 1
    },
    {
        "id": "65811",
        "nombre": "Cableado Estructurado",
        "nivel": 1
    }
]