PlanningPME API

Este documento le informará sobre:

Definición y rol de una API
La volumetría de la API de PlanningPME
La vocación de las API de PlanningPME estándar y personalizada

Definición y rol: ¿Qué es una API?

Una API es una interfaz de programación de aplicaciones, en espanol una interfaz de programación de aplicaciones. Vamos a explicar cada uno de estos términos para entender mejor  

  • -   "Aplicación": una aplicación es un servicio al que puede acceder un humano o un programa informático.
    Ex  : Facebook es una aplicación de red social, Spotify es una aplicación de transmisión de audio, PlanningPME es una aplicación para planificar
  • -   "Programación": un programa es un conjunto de funciones de computadora escritas por un desarrollador que realiza tareas en su lugar.
    Ex  : Si quiero transformar las direcciones postales en coordenadas geográficas, puedo hacerlo manualmente, o puedo escribir un programa que lo haga automáticamente.
  • -   "Interfaz": una interfaz hace la conexión entre dos cosas, aquí entre una aplicación y los programas que la usan. Define lo que el programa puede solicitar a la aplicación, transmite las solicitudes del programa a la aplicación y las respuestas de la aplicación al programa.

PlanningPME - API
Así como un control remoto es la interfaz utilizada por un espectador para programar su televisor, una API es la interfaz utilizada por un programador para interactuar con una aplicación.

La API de PlanningPME es la interfaz de la aplicación PlanningPME y desempeña un papel importante.
Como punto de cruce obligatorio, es capaz de identificar los accesos, asegurar las transmisiones, controlar el volumen de solicitudes, etc.


Volumetría: ¿Cuáles son los límites de llamada de la API de PlanningPME?

Cada instalación de una API de PlanningPME tiene una clave de uso, llamada AppKey. Autentica un programa (o conjunto de programas) a la API.

La misma AppKey tiene por defecto un volumen máximo de 2,000 consultas por hora.
Más allá de este límite, se notificará al propietario de la llave del exceso y su plan se ajustará de acuerdo con el siguiente esquema de tarifas.

BásicoMilliMicroNanoPlus
2 000 consultas / hora3 000 consultas / hora5 000 consultas / hora8 000 consultas / hora+ 10 000 consultas / hora
Gratis15 € / mes30 € / mes50 € / mesConsultarnos

Ex  : mi programa realiza 4.500 consultas en menos de una hora con la misma AppKey. Se me notifica por correo electrónico que mi cuota por hora ha alcanzado la porción "Micro" y que se me cobrarán 30 € al final del mes.

Más de 10.000 solicitudes / hora es obligatorio un acuerdo previo.
Cualquier clave que exceda esta cuota de uso máxima sin permiso se desactivará de inmediato.


Vocación: ¿Cuáles son las diferencias entre la API estándar y la API personalizada?

La API de PlanningPME tiene dos tipos de operaciones.

La API estándar le permite realizar todas las operaciones de la unidad en la aplicación PlanningPME.

Ex  : agregar / modificar / eliminar un evento, actualizar un cliente / proyecto / recurso, modificar los derechos de un grupo, cambiar una opción, etc.

Todas estas operaciones se describen en el documentación interactiva de la API PlanningPME .

La API personalizada permite que operaciones masivas se realicen en la aplicación PlanningPME y que configuren estas operaciones dentro de los modelos de integración.

Ex  : envío la información actualizada de mis 25,000 clientes a la API, en una sola solicitud y en un formato predefinido y personalizado, la API es responsable de actualizar todos mis clientes ya básico, para agregar los nuevos, o para eliminar antiguos clientes.

Estas operaciones, también llamadas operaciones de integración (método de "integración" de la API), se definen dentro de los modelos de integración.

Se recomienda encarecidamente utilizar la API personalizada para implementar cualquier sincronización masiva (por ejemplo, tipo cliente / recurso / proyecto), para no exceder las límites de uso de su llave. Una sincronización realizada utilizando la API personalizada cuesta una sola consulta, independientemente del número de elementos actualizados en dicha consulta.

Consulte la documentación para API personalizada de integración para más información.