Skip to main content

Getting Started

As illustrated in the architecture overview page, your booking / validation / display solution will consist of an application and a server.

Your booking / validation / display application will have to communicate with the Lineberty server to get the data needed to book or validate a ticket. This communication requires an API Key.

Getting Started

In addition to this, you will need a server to be the link between your application and the Lineberty server.
This server has a vital role: it will request the API Key and perform other secured requests through a bearer placed in the header. This increases the security between your application and the Lineberty API.

➀ Getting a Private Key​

First of all, we will provide you with a private key, created especially for you, included in a JSON file.

caution

This JSON file must be stored safe on your application server, and of course kept secret.

Below is an example of such a JSON file. The private key is on the line "private_key".

{
    "type": "service_account",
    "project_id": "projet-id-315217",
    "private_key_id": "123456789ABCDEF123456789ABCDEF",
    "private_key": "-----BEGIN PRIVATE KEY-----\n-----YOUR_PRIVATE_KEY-----\n-----END PRIVATE KEY-----\n",
    "client_email": "'YOUR_EMAIL_ACCOUNT'",
    "client_id": "123456789123456789",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/'YOUR_EMAIL_ACCOUNT'"
}

➁ Getting a Private Account​

This private key also contains an email address ("client_email"). This is the email associated to your account to access the Lineberty API, and afterwards get the API Key.

➂ Accessing the API and the Documentation​

In addition to this private key, we will provide you with an OpenAPI file, corresponding either to the Booking API, the Validation API, or the Display API including the Reference Documentation.

  • The OpenAPI file: It contains all the paths, parameters, requests, responses you will need to access and use the resources of the Lineberty API. Sample responses and models are also included.
  • The Reference Documentation: Detailed information is provided within the file to describe each method, the parameters and the error codes.