ProjectSight API

Om deze optimaal te bekijken, opent u de PDF in een browser.

U kunt de ProjectSight API gebruiken om informatie in uw portfolio's en projecten te bekijken. Om toegang te vragen, stuurt u een e-mail naar ProjectSightAPISupport@trimble.com.

Nadat u uw applicatie hebt geregistreerd, kunt die bij de API abonneren en daarna een beveiliging token verkrijgen. Het token is gekoppeld aan uw Trimble account inloggegevens en is geldig voor de periode die is gedefinieerd in het token response.

  1. Meld u aan bij API Cloud met uw Trimble account.
  2. Op de pagina Discover API (API ontdekken) selecteert u ProjectSight of ProjectSight-EU.
  3. Selecteer Subscriptions.
  4. In het gedeelte Create Subscription (abonnement aanmaken) selecteert u uw applicatie en daarna selecteert u Subscribe (abonneren).
    5. Abonnement aanmaken
  1. In API Cloud selecteert u ProjectSight of ProjectSight-EU.
  2. Selecteer Get Key (sleutel ophalen).
  3. Kopieer de volgende waarden:
    • Application Name
    • Consumer Key
    • Consumer Secret
    • Package & Usage Plan Key
    Key info ophalen
  4. Om een beveiliging token te verkrijgen van Trimble Identity, POST u een aanvraag bij https://id.trimble.com/oauth/token met de volgende informatie:
    • Header: Authorization

      • Value: Basic Key

      De key in de Authorization waarde is één tekenreeks die bestaat uit de Consumer Key en het Consumer Secret, gescheiden door een dubbelepunt (ConstumerKey:ConsumerSecret) en vervolgens Base64-gecodeerd.

    • Header: Content-Type

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

    • Body:

      • grant_type=client_credentials

      scope=[Application Name]

      Vervang [Application Name] door de waarde gekopieerd in de vorige stap.

      Voorbeeld:

      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

    • Als de aanvraag gelukt is, bevat de response een Json klasse met verschillende eigenschappen.
      • De access_token eigenschap word gebruikt om de API calls te maken.
      • De expires_in eigenschap definieert hoeveel seconden het token geldig is.
    • Als de aanvraag mislukt is, bevat de response twee velden, error en error_description, die het probleem beschrijven,
  1. In API Cloud selecteert u ProjectSight of ProjectSight-EU.
  2. Voor meer informatie over de API endpoints raadpleegt u de documentatie voor ontwikkelaars.
    • Om de URL te vinden die u gaat gebruiken om de API voor uw applicatie te gebruiken, selecteert u API Endpoint.
      • URL voor toegang tot API
  1. Vraag Trimble Support om een nieuwe applicatie in API Cloud aan te maken.
  2. Abonneer u op de nieuwe applicatie en gebruik de consumer key en consumer secret hiervan voor uw ProjectSight integraties.
    1. Meld u aan bij API Cloud en selecteer ProjectSight of ProjectSight-EU.
    2. Selecteer het tabblad Subscriptions (abonnementen).
    3. In het gedeelte Create Subscription (abonnement aanmaken) selecteert u uw applicatie en daarna selecteert u Subscribe (abonneren).
      4. Abonneren op API
    4. Selecteer Get Key (sleutel ophalen).
      5. Key ophalen
    5. Om de consumer key en het consumer secret voor de nieuwe applicatie te bekijken en te kopiëren, selecteert u de nieuwe applicatie in de lijst.
      6. Key en secret kopiëren
    6. Werk uw ProjectSight integraties bij met de nieuwe consumer key en consumer secret.

      7. De Package & Usage Plan Key (d.w.z. x-api-key HTTP header) verandert niet. Alleen de Consumer Key en het Consumer Secret zijn uniek voor elk applicatie abonnement.

  3. Om het abonnement op de oude applicatie te verwijderen, selecteert u Revoke Key (key intrekken) naast de oude applicatie.
    4. Key van oud abonnement intrekken

Limieten

Op basis van de bijgewerkte hulpinformatie van Trimble Cloud hoeft u de x-API-key niet naar de trimblepaas.com endpoints door te geven. Als u dat wel doet, is er een limiet van 50 aanvragen per seconde.

Ondersteunde functies

De volgende record typen worden ondersteund:

  • Account
  • ActionItem
  • ApplicationForPayment
  • Budget
  • BudgetCodeStructure
  • BudgetGroup
  • BudgetSnapshot
  • ChangeOrderRequest
  • Checklist
  • Company
  • Contract
  • ContractInvoice
  • DailyReport
  • Drawing
  • DrawingSet
  • FieldWorkDirective
  • File
  • Folder
  • Forecast
  • GeneralInvoice
  • Issue
  • JobCosts
  • LookupList
  • Meeting
  • Notice
  • Photo
  • POCatalog
  • Portfolio
  • PotentialCO
  • PrimeContractCO
  • Project
  • PunchList
  • PurchaseOrder
  • Records
  • ReportGenerator
  • RFI
  • Role
  • SafetyNotice
  • SubContractCO
  • Submittal
  • SubmittalPackage
  • Transmittal
  • User
  • WorkflowStates

Voor de ondersteunde record typen zijn de volgende API bewerkingen beschikbaar:

  • Een record ophalen
  • Een record verwijderen
  • Een verzameling records ophalen
  • Een record aanmaken of bijwerken
  • Een verzameling records ophalen op basis van een query request
  • Workflow statussen voor records ophalen
  • Een lijst van beschikbare rapporten ophalen
  • Een lijst van beschikbare UDF's ophalen

Sommige record typen hebben verschillende bewerkingen.