API de ProjectSight

Para una visualización óptima, abra el PDF en un navegador.

Puede usar la API de ProjectSight para ver y actualizar información en sus portafolios y proyectos. Para solicitar acceso, envíe un correo electrónico a ProjectSightAPISupport@trimble.com.

Después de registrar su aplicación, puede suscribirse a la API y luego obtener un token de seguridad. El token está asociado con sus credenciales de cuenta de Trimble y es válido durante el período de tiempo definido en la respuesta del token.

  1. Inicie sesión en API Cloud con su cuenta de Trimble.
  2. En la página Descubrir API , seleccione ProjectSight o ProjectSight-EU.
  3. Seleccione Suscripciones.
  4. En la sección Crear suscripción , seleccione su aplicación, y luego elija Suscribir.
    5. Crear suscripción
  1. En API Cloud, seleccione ProjectSight o ProjectSight-EU.
  2. Seleccione Obtener clave.
  3. Copie los siguientes valores:
    • Nombre de la aplicación
    • Consumer Key (Clave del consumidor)
    • Consumer Secret (Secreto del consumidor)
    • Package & Usage Plan Key (Clave del plan de uso del paquete)
    Información sobre obtener clave
  4. Para obtener un token de seguridad desde Trimble Identity, envíe una solicitud POST a https://id.trimble.com/oauth/token con la siguiente información:
    • Encabezado: Authorization

      • Valor: Basic Key

      La clave en el valor Authorization es una cadena única que consiste en la Consumer Key y el Consumer Secret, separados por dos puntos (ConsumerKey:ConsumerSecret)y luego codificada en Base64).

    • Encabezado: Content-Type

      • Valor: application/x-www-form-urlencoded

    • Cuerpo del mensaje:

      • grant_type=client_credentials

      scope=[Application Name]

      Reemplace [Application Name] con el valor que copió en el paso anterior.

      Ejemplo:

      POST https://id.trimble.com/oauth/token/
      Authorization: Basic TE9pU...
      Content-Type: application/x-www-form-urlencoded
      Accept: application/json
      Cache-Control: no-cache

      grant_type=client_credentials
      scope=Trimble-ProjectSightApp1

    • Si la solicitud es exitosa, la respuesta incluye una clase Json con varias propiedades:
      • La propiedad access_token se usa para realizar llamadas a la API.
      • La propiedad expires_in define la duración del token en segundos.
    • Si la solicitud falla, la respuesta incluye dos campos, error y error_description, que describen el problema.
  1. En API Cloud, seleccione ProjectSight o ProjectSight-EU.
  2. Para más información sobre los endpoints de la API, consulte la documentación para desarrolladores.
    • Para buscar la URL para acceder a la API para su aplicación, seleccione API Endpoint.
      • URL para acceder a la API
  1. Pida al equipo de soporte de Trimble que cree una nueva aplicación en API Cloud.
  2. Suscríbase a la nueva aplicación y use su consumer key y consumer secret para sus integraciones con ProjectSight.
    1. Inicie sesión en API Cloud, y seleccione ProjectSight o ProjectSight-EU.
    2. Seleccione la pestaña Suscripciones .
    3. En la sección Crear suscripción , seleccione su aplicación, y luego elija Suscribir.
      4. Suscríbase a la API
    4. Seleccione Obtener clave.
      5. Obtener clave
    5. Para ver y copiar la ‘consumer key’ y el ‘consumer secret’ para la nueva aplicación, seleccione la nueva aplicación de la lista.
      6. Copiar Consumer key y Consumer secret
    6. Actualice sus integraciones con ProjectSight con los nuevos valores de Consumer key y Consumer secret.

      7. La clave del plan de uso del paquete (es decir, encabezado HTTP x-api-key) no cambia. Solo Consumer Key y Consumer Secret son únicos a cada suscripción a la aplicación.

  3. Para quitar la suscripción de la aplicación anterior, seleccione Revocar clave al lado de la antigua aplicación.
    4. Revocar clave de la suscripción anterior

Límites de velocidad

Según la guía actualizada de Trimble Cloud, no es necesario incluir el parámetro x-API-key en las solicitudes a los endpoints de trimblepaas.com. Si lo incluye, existe un límite de 50 solicitudes por segundo.

Funciones compatibles

Los siguientes tipos de registro son compatibles:

  • Cuenta
  • ÍtemAcción
  • SolicitudPago
  • Presupuesto
  • EstructuraCódigoPresupuestario
  • GrupoPresupuestario
  • InstantáneaPresupuesto
  • SolicitudOrdenCambio
  • Lista de verificación
  • Empresa
  • Contrato
  • FacturaContrato
  • InformeDiario
  • Plano
  • ConjuntoPlanos
  • DirectrizTrabajoCampo
  • Archivo
  • Carpeta
  • Pronóstico
  • FacturaGeneral
  • Problema
  • CostosObra
  • ListaSelección
  • Reunión
  • Aviso
  • Foto
  • CatálogoOComp
  • Portafolio
  • OCPotencial
  • OCContratoPrincipal
  • Proyecto
  • ListaInspección
  • OrdenCompra
  • Registros
  • GeneradorRegistros
  • RFI
  • Rol
  • AvisoSeguridad
  • OCSubcontrato
  • Entregable
  • PaqueteEntregables
  • Transmisión
  • Usuario
  • EstadosFlujoTrabajo

Para los tipos de registros admitidos, las siguientes operaciones API están disponibles:

  • Obtener un registro
  • Eliminar un registro
  • Obtener una colección de registros
  • Crear o actualizar un registro
  • Obtener una colección de registros basada en una solicitud de consulta
  • Obtener estados de flujo de trabajo de registros
  • Obtener una lista de informes disponibles
  • Obtener una lista de archivos UDF disponibles

Algunos tipos de registro tienen operaciones distintas.