Skip to main content

Welcome

Welcome to the developer documentation of Linckr that explains how to integrate your ERP-system or app seamlessly with Linckr. Before diving into the technical details of the Service Provider API it is important to:

  1. understand from a functional perspective what the Linckr Platform is about
  2. to get access to the staging environment and experience the consumer app and provider web portal yourself
  3. explore the Provider API and get familiar with the domain concepts

The Linckr Platform from a functional perspective​

The Linckr platform consists of two primary applications, each targeting a different user type:

  1. the Linckr app for consumers:
    • in this consumer tutorial a detailed walkthrough about the functional features can be found
    • the app is accessible via a mobile app, both for IOS and Android, as well as via a web application in the browser. The consumer API itself is not available for third parties
  2. the Linckr web portal and API for service providers
    • in this service provider tutorial a detailed walkthrough about the functional features can be found
    • the web portal is made available to service provider office users via a browser
    • the service provider API is made available as a GraphQL API for third parties

Get access to the staging environment​

The staging environment is used for final acceptance testing before a new release is rolled out. There is no production data on this environment and this environment is also linked to test environments of external systems.

info

the staging environment is available every day, but only within the time window: 8:00 - 20:00. Outside of that, this environment is not online. This applies to both the mobile app for consumers and the service portal for service providers.

Requesting access​

Requesting access to the staging (pre-production) environment of Linckr, can be done by sending an email to developer@linckr.com with the following content:

  • to get access to the service portal we require a list of emails that require access
  • to give access to the mobile app on staging, we need the email addresses from either the Apple ID (Iphone user) or Google Play account (Android user) for each user. Note this is often a personal email.
  • a brief description of the context and goal of the integration

Test your access​

Service provider portal​

Once access is granted to the service provider web portal, users will receive an invitation email from noreply@linckr.com with the question to join a service provider organisation. This email contains an invitation link. Note that your email will be postfixed with +stagingLinckr, so you can see that this email is tied to the staging environment. When creating your account on the service portal we recommend making use of the same email address with the postfix.

After you have signed up, bookmark this link: https://serviceportal.staging.linckr.com

Consumer app​

For the consumer app:

  • IOS users will receive an email sent by Apple, with instructions to download the TestFlight app.
  • Android users have to open the following link and join the testers program. Note this link will only work after Linckr has granted access.

The consumer app on staging can be either tested via the mobile app, or by visiting the web version. To, login on the web version, a QR code must be scanned and this can only be done from within the mobile app. In all cases, a consumer must download and sign up on the mobile app first, before the web version can be used.

Explore the Provider API​

Linckr is an API-first platform that provides a GraphQL API secured by the OIDC/OAUTH2 standards. The Provider-API is open for integration and focuses on the provider domain. This API is also used by the Service Portal Web App.

Important links:

tip

Before diving into the API please read through the domain concepts in the next section

Contact​

For technical questions please contact developer@linckr.com

For end-users with questions please contact support@linckr.com and checkout the FAQ