Desarrolladores
Introducción
La API de Salexis permite a desarrolladores expandir la plataforma de Salexis.com.
La API es una interfaz para acceder a los datos de su cuenta en Salexis utilizando el protocolo HTTP. La API permite fácilmente crear aplicaciones web y de escritorio que se integren con su cuenta.
Algunos ejemplos de aplicaciones posibles:
- Herramientas de importación y exportación de datos.
- Análisis de datos complejos.
- Integración con pasarelas de pago externas.
- Automatización de tareas dentro de la plataforma.
Para activar la API, se debe ingresar en su cuenta de Salexis, ir al enlace con su nombre y marcar la casilla “¿Utilizar la API?”, al grabar se genera una API KEY. Este clave es la necesaria para realizar las llamadas a la API distinguiendo un usuario de otro. Guarde este clave con seguridad y no la revele a terceros.
URL de acceso a la API
Para acceder se debe utilizar una dirección derivada de su cuenta:
http://ejemplo.salexis.com/api/1.0/entidad/función.formato
o bien, si su cuenta posee seguridad SSL, puede utilizar:
https://ejemplo.salexis.com/api/1.0/entidad/función.formato
Donde “ejemplo” se corresponde con el nombre de su cuenta; “entidad/función”, es una de las llamadas de la API y “formato“ puede ser “xml”, “json” o “yaml” dependiendo el formato de los datos que deseamos recuperar.
Puede acceder a la referencia completa de la funcionalidad de la API.
Comienzo Rápido
Para realizar algunas consultas es muy simple utilizar las utilidades “curl” o “wget” por ejemplo:
curl "http://SU_NOMBRE_DE_CUENTA.salexis.com/api/1.0/contacts/list.json?api_key=SU_CLAVE_PARA_LA_API"
o bien, si queremos la respuesta en XML:
curl "http://SU_NOMBRE_DE_CUENTA.salexis.com/api/1.0/contacts/list.xml?api_key=SU_CLAVE_PARA_LA_API"
Hemos creado una serie de ejemplos que le permitirán empezar a utilizar la API de manera muy rápida. Puede consultar la sección de ejemplos donde vamos listando ejemplos en diferentes lenguajes de programación.
Formato de los datos
Los datos enviados o recibidos deben estar en formato UTF-8. Las fechas deben estar en el formato YYYY-MM-DD HH:MM:SS.
Errores
El usuario de la API debe revisar luego de cada llamada el “HTTP Status Code” retornado, los estados retornados pueden ser:
- 200: Respuesta ok
- 400: Bad Request. Solicitud inválida (generalmente error en los parámetros de entrada) un mensaje de error indicará el problema.
- 401: Authorization Required
- 403: Invalid API Key
- 403: Invalid Account
- 403: Expired or Bad API Key
- 404: Resource Not Found
- 500: Server Error
