Descripción general de los endpoints de la API de Plecto

Lista de endpoints de la API de Plecto

Plecto le permite acceder a los siguientes endpoints usando la URL base de V2 o V3:

URL base: https://app.plecto.com/api/v2/

Endpoints de V2, agrupados por tema:

• /dashboards/

• /datasources/

• /registrations/

• /members/

• /teams/

  • /my-teams/

• /slideshows/

  • /screens/

  • /screen-devices/

  • /devices/

• /favorites/

• /formulas/

URL base: https://app.plecto.com/api/v3/

Endpoints de V3:

• /achievement-types/

  • /achievement-type-icons/

• /posts/

Dashboards

{
  "parent": null,
  "level": 0,
  "title": "API Dashboard",
  "organization": "organization_uuid",
  "theme_id": "dark_blue"
}

• Endpoint: https://app.plecto.com/api/v2/dashboards/

• Métodos: GET, POST

• Descripción: Obtener o crear dashboards en Plecto. GET devuelve detalles sobre los dashboards existentes, mientras que POST crea un nuevo dashboard.

• Ejemplo de solicitud POST arriba

Data sources

{
  "title": "New API Data Source",
  "fields": [
    {
      "name": "Units Sold",
      "input": "DecimalInput",
      "default_value": ""
    },
    {
      "name": "Product Name",
      "input": "TextInput",
      "default_value": "Coffee"
    }
  ]
}

• Endpoint: https://app.plecto.com/api/v2/datasources/

• Métodos: GET, POST

• Descripción: Acceder a o crear fuentes de datos, que sirven como base para gestionar datos dentro de Plecto.

• Ejemplo de solicitud POST arriba

Registrations

{

"data_source": "12a121212044412faf1b4801b0eb20e8",

"member": "e1c222ebbc1812be1cbb1c101ced4523",

"external_id": "0p23oi5",

"date": "2024-10-10T10:22:55",

"Product Name": "Green tea",

"Units Sold": 2

}

• Endpoint: https://app.plecto.com/api/v2/registrations/

• Métodos: GET, POST, PUT, DELETE

• Descripción: Obtener, actualizar o eliminar registros asociados a una fuente de datos.

• Información de uso:

  • Puede usar GET, PUT y DELETE en un registro específico en la URL /api/v2/registrations/<data_source>/<uuid>/

  • Puede filtrar registros con los siguientes parámetros de cadena de consulta:

    • start_date (https://app.plecto.com/api/v2/registrations/?start\_date=2024-06-01T22:22:00)

    • end_date (https://app.plecto.com/api/v2/registrations/?end\_date=2024-06-01T22:22:00)

    • reference/external_id (https://app.plecto.com/api/v2/registrations/?reference=123)

    • data_source (https://app.plecto.com/api/v2/registrations/?data\_source=412c64d13fbf4c89bacd4224fb16a6db)

  • Puede controlar la paginación con el parámetro "page".

• Ejemplo de solicitud POST a /api/v2/registrations/ arriba

Members

{
   "updating_api_provider_id": "Postman_ID",
   "updating_api_provider": "Postman",
   "updating_api_provider_email": "jane.doe@example.com",
   "name": "Jane Doe",
   "is_active": true,
   "teams": 000000
}

• Endpoint: https://app.plecto.com/api/v2/members/

• Métodos: GET, POST

• Descripción: Gestionar los datos de los miembros de la organización. Los miembros aparecerán listados en la página Empleados de Plecto, y si envían datos, se mostrarán en las fuentes de datos correspondientes.

• Información de uso: Use GET para filtrar según parámetros como api_provider o api_id, y POST para añadir nuevos miembros:

  • GET /api/v2/members/?api_provider=<su api_provider>&api_id=<su id>

• Ejemplo de solicitud POST arriba

Teams

{
    'name': 'api-team',
    'organization': org_id,
    'data_sources': [id1, id2],
    'members': [member1_id, member2_id, member3_id],
    'managers': [member1_id, member2_id],
}

• Endpoint: https://app.plecto.com/api/v2/teams/

• Métodos: GET, POST

• Descripción: Crear o listar equipos dentro de Plecto. Los equipos se usan para agrupar miembros y asociarlos con dashboards, fuentes de datos y otras funciones.

• Ejemplo de solicitud POST arriba

My teams

• Endpoint: https://app.plecto.com/api/v2/my-teams/

• Métodos: GET

• Descripción: Lista los equipos de los que el usuario autenticado es miembro o gestor. Los administradores globales seguirán viendo todos los equipos; todos los demás usuarios solo verán sus equipos asociados.

teams vs. my-teams: ¿cuál es la diferencia?

La diferencia entre los endpoints /teams/ y /my-teams/ radica en el alcance y los detalles de los datos que proporcionan:

Alcance de los datos:

• /teams/ obtiene todos los equipos dentro de la organización. Proporciona información sobre cada equipo, incluyendo su id, uuid, miembros, gestores, organización y fuentes de datos asociadas.

• /my-teams/ devuelve solo los equipos que están directamente asociados con el usuario autenticado. Estos suelen ser los equipos de los que el usuario es miembro o gestor.

Detalles de la respuesta:

• /teams/ proporciona un conjunto de datos más completo para cada equipo, como id, organization, data_sources, home_dashboard y home_screens. Utiliza ID numéricos para miembros y gestores.

• /my-teams/ ofrece una vista simplificada de cada equipo, omitiendo algunos campos como organization, home_dashboard y data_sources. La respuesta incluye un campo picture y utiliza UUID para miembros y gestores en lugar de ID numéricos.

Diferencias en el caso de uso:

• Use /teams/ cuando necesite una lista completa de todos los equipos de la organización o requiera información detallada sobre los equipos.

• Use /my-teams/ para obtener rápidamente los equipos con los que el usuario autenticado está asociado, lo cual es útil para dashboards personalizados o funcionalidades específicas del usuario.

Slideshows

{
    "name": "My New Slideshow",
    "dashboards": [],
    "rotation": "",
    "slides": [
    {
    "url": "https://www.youtube.com/watch?v=-UPdU4npGm0",
    "dashboard": null,
    "contest_dashboard": null,
    "duration": null,
    "time_from": "00:00:00",
    "time_to": "23:59:59",
    "dynamic_context": null,
    "ordering": 0
    }
    ,
    {
    "url": null,
    "dashboard": 179312,
    "contest_dashboard": null,
    "duration": null,
    "time_from": "00:10:00",
    "time_to": "18:59:59",
    "dynamic_context": null,
    "ordering": 0
    }
    ],
    "slide_duration": 60
}

• Endpoint: https://app.plecto.com/api/v2/slideshows/

• Métodos: GET, POST

• Descripción: Use esto para gestionar sus presentaciones de diapositivas de Plecto. Puede crear presentaciones con varios tipos de diapositivas: dashboard, concurso, YouTube y URL.

• Ejemplo de solicitud POST arriba

Screens

• Endpoint: https://app.plecto.com/api/v2/screens/

• Métodos: GET

• Descripción: Obtener una lista de presentaciones de diapositivas (slideshows). Los detalles incluyen el UUID de la presentación, el nombre, la rotación y el UUID de la organización.

Screen devices

• Endpoint: https://app.plecto.com/api/v2/screen-devices/

• Métodos: GET

• Descripción: Este endpoint devuelve una lista de pantallas (televisores o pantallas de ordenador) a las que se han enviado sus presentaciones de diapositivas.

Dispositivos

{
   "device_name": "New Device",
   "device_type": "tv",
   "device_id": "tv_id",
   "username": "user@example.com",
   "password": "userpassword"
}

• Endpoint: https://app.plecto.com/api/v2/devices/

• Métodos: GET, POST

• Descripción: Obtener o crear dispositivos vinculados al usuario de la API, como un televisor activado o una aplicación móvil en la que el usuario haya iniciado sesión.

• Ejemplo de solicitud POST arriba

El nombre de usuario y la contraseña son necesarios para crear un token, que recibirá en la respuesta de la solicitud.

Favoritos

{
    "dashboard": 180529,
    "order": 0
}

• Endpoint: https://app.plecto.com/api/v2/favorites/

• Métodos: GET, POST

• Descripción: Obtener dashboards marcados como favoritos o añadir nuevos favoritos. Los dashboards favoritos aparecen como accesos directos en la página de inicio de la interfaz de Plecto.

• Ejemplo de solicitud POST arriba

Formulas

{
   "title": "Total Number of Adversus Appointments",
   "format": "(Count(Adversus Appointments))",
   "prefix": "",
   "suffix": "",
   "output": "DecimalOutput",
   "decimals": 0,
   "lower_value_is_better": false,
   "conditional_colors": [
        {"value": "20", "color": "red"},
        {"value": "70", "color": "yellow"},
        {"value": "100", "color": "green"}
   ],
   "owner": null
}

• Endpoint: https://app.plecto.com/api/v2/formulas/

• Métodos: GET, POST

• Descripción: Obtener o crear fórmulas. Todas las fórmulas son universales y se pueden usar en todas las funciones de Plecto.

• Ejemplo de solicitud POST arriba

Achievements

{
   "name": "API Achievement",
   "category": "membership",
   "description": "This is an achievement description sent via API",
   "icon": "diamond",
   "custom_icon": null,
   "icon_id": "diamond",
   "shape": "hexagon",
   "color": "silver",
   "time_period": "",
   "show_next_to_name": true
}

• Endpoint: https://app.plecto.com/api/v3/achievement-types/

• Métodos: GET, POST

• Descripción: Obtener o crear nuevos logros (achievements) en Plecto. Elija entre logros de premio, récord o membresía. Obtenga más información sobre cómo funcionan los logros aquí.

• Ejemplo de solicitud POST arriba

Achievement type icons

• Endpoint: https://app.plecto.com/api/v3/achievement-type-icons/

• Métodos: GET

• Descripción: Obtener los iconos de sus insignias de logros. Recibirá los enlaces de las imágenes en el cuerpo de la respuesta.

Publicaciones del feed de noticias

{
    "content": "Today is Tuesday, which means it's cake day!",
    "organization_scope": true
}

• Endpoint: https://app.plecto.com/api/v3/posts/

• Métodos: GET

• Descripción: Leer publicaciones y enviar actualizaciones a su feed de noticias de Plecto.

• Ejemplo de solicitud POST arriba

Themes

{
   "name": "My New Theme",
   "text_color": "#5d5d5d",
   "background_color": "#f9f9f9",
   "background_image": null,
   "background_image_thumbnail": null,
   "background_position": "cover",
   "widget_green_color": "",
   "widget_green_background_color": null,
   "widget_green_background_text_color": null,
   "widget_yellow_color": "",
   "widget_yellow_background_color": null,
   "widget_yellow_background_text_color": null,
   "widget_red_color": "",
   "widget_red_background_color": null,
   "widget_red_background_text_color": null,
   "widget_background_color": "#f9f9f9",
   "widget_border_color": "#f1f1f1",
   "widget_border_radius": "15px",
   "widget_chart_color": "",
   "widget_chart_colors": null,
   "widget_chart_gradients": true,
   "widget_table_achievement_color": "",
   "is_custom": true
}

• Endpoint: https://app.plecto.com/api/v2/themes/

• Métodos: GET, POST

• Descripción: Obtener o crear nuevos temas que pueda usar en los dashboards y concursos de Plecto.

• Ejemplo de solicitud POST arriba