Door software pakketten te koppelen kan handmatige arbeid geautomatiseerd worden. Voorkom dubbel werk, irritaties en fouten.


De API van Tim is benaderbaar via TimSaas.com. Tim API werkt met een API sleutel. Deze API sleutel is verbonden aan een gebruiker. Met deze API sleutel kun je een access token genereren. Dit token gebruik je bij het aanroepen van de API.


Aanvragen API key

De API key wordt door Softmakers aangemaakt. Je kunt een API key dus bij ons opvragen. De API key is een GUID.



Gebruik API Key

De base URL = https://start.timsaas.com/TimApi/ 


Het opvragen van een Token. 

{{BaseUrl}}api/ApiAccess?tenantId=N&userId=N&apiKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX


De response is een JSON.

{
  "AccessToken": "eyJhbGciPiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IjQwZDVkMGM0LTA5ZTAtNDM2Yi1hODU2LWU4OGE1KDIzMThmZSIsIm5iZiI6MTU3NTMwNDAyMCEiZXhwIjoxNjA2OTI2NTIwLCJpYXQhspE1NzUzMDQxMjB9.DPoUtMoy6KAyDg0c0RsRurHmjbZ4Y2RhEZyGJHwBe7Q",
  "TokenValid": "2021-01-31T17:28:40.3946847+01:00",
  "TenantIds": [
    {
      "TenantId": 912,
      "Name": "API bedrijf",
      "TenantType": {
        "TypeId": 2,
        "Description": "Production"
      },
      "UserRole": null,
      "ApiLocations": null
    }
  ]
}


Het access token is het token dat je moet gebruiken als bearer token in de header van iedere call die je aanvraagt bij de Tim API. Momenteel blijft dit token een 8 uur geldig. Verder heb je bij alle calls het tenant id nodig. In dit voorbeeld is dit 912.


API Calls


Via https://{develop.}timsaas.com/TimApi/help kun je zien welke Tim API calls je kunt aanroepen. Hieronder een voorbeeld voor het aanroepen van een DoProcedure. We gebruiken hier een PUT

{{BaseUrl}}/api/DoProcedure?tenantId=N&procedurename=TWC_GetCustomerData


Body

[
  {
    "Name": "@TenantId",
    "DataType": 8,
    "Value": 912
  },
  {
    "Name": "@UserName",
    "DataType": 3,
    "Value": "huibvandersteen@softmakers.nl"
  }
]


Response voorbeeld:

Je krijgt een HTTP response codes ofwel HTTP Status code en een eventuele JSON als dit nodig is

Voorbeeld:

{
  "EntityId": 390000899,
  "EANCode": "G871607401008341743",
  "EndAuthorization": "2012-01-01T00:00:00Z",
  "StreetName": "Brederoplein",
  "StreetNr": "1308",
  "ZipCode": "3594 XX",
  "City": "UTRECHT",
  "Country": "Nederland"
}


Je kunt je code testen via Swagger op https://start.timsaas.com/TimApi/swagger/ui/index