Loby API

The base URL to send all API requests ishttps://api.loby.io. HTTPS is required for all API requests.

The Loby API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests. Request and response bodies are encoded as JSON and therefore requests need to include the headercontent-type: application/jsonwhen appropriate.

Use Loby API to retrieve, create or modify data stored in your Loby account programmatically and to create custom integrations.

Versions

There is currently one version, which is reachable via:https://api.loby.io/v1

Error Codes

Authentication

Loby API uses API access tokens to authenticate requests. You can view and manage your API keys in Loby.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

The API key should be passed as a Bearer authorization header, e.g.:

Authorization: Bearer {{accessToken}}

Replace{{accessToken}}with your key from Loby.

Resources

Customer

List Customers

GET /customers

You can use this endpoint to retrieve a list of customers. You can use thefilterparameter to filter the list of customers.

Use thePaginationandQueryingsections to learn more about how to complete this request.

List of available fields to query:

Getting a customer

GET /customers/:id

If you have an id for a customer, you can use this endpoint to retrieve the customer.

Example response

{
  "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f",
  "firstName": "Henny",
  ...
}

Create a customer

POST /customers

You can create a new customer by providing any of the following fields:

Update a customer

PATCH /customers/:id

You can update a customer by providing any of the following fields:

Set to null to remove the field.

Deleting a customer

DELETE /customers/:customerId

MembershipType

A membership type is a type specification, that is referred to when issuing new memberships.

List Membership Types

GET /membership-types

You can use this endpoint to retrieve a list of membership types.

Use thePaginationandQueryingsections to learn more about how to complete this request.

MembershipTypeTranslation

AMembershipTypeTranslationcontains translated fields for the object.

Membership

AMembershiprepresents an entered membership, that has a MembershipType. A Membership can e.g. be used to get benefits or to get access to the museum.

List of available fields to query:

Issuing membership

POST /customers/:customerId/memberships

You can post a new membership by providing the following fields:

Updating af membership

PATCH /memberships/:membershipId

You can update the following fields:validFrom,validTo,autoRenew,preferredRenewalMembershipTypeId,payerId

Deleting a membership

DELETE /memberships/:membershipId

Send membership email

POST /memberships/:membershipId/send-email

This will automatically send a membership email to the customer.

Verifying the validity of a membership via a QR code

GET /verify-membership-qr-code/:qrData

The variableqrDatais the entire data for the qr code e.g.https://test...?qr=test. It needs to be url encoded. So in that means something like this:https%3A%2F%2Ftest...%2F%3Fqr%3DHX9Smn5X%252

It will always return a response with the booleanvalid.

{
  "valid": true
}

Ticket Type

A ticket type is a type specification, that is referred to when issuing new tickets.

List Ticket Types

GET /ticket-types

You can use this endpoint to retrieve a list of ticket types.

TicketTypeTranslation

ATicketTypeTranslationcontains translated fields for the object.

Ticket

ATicketrepresents an issued ticket, that has a TicketType. A Ticket can e.g. be used to get access to the museum.

Getting a ticket

GET /tickets/:id

If you have an id for a ticket, you can use this endpoint to retrieve the ticket.

Example response

{
  "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f",
  "number": 3455,
  ...
}

Issuing a ticket

POST /tickets

You can post a new ticket by providing the following fields:

Deleting a ticket

DELETE /tickets/:ticketId

Location

A location can be used for various things. Eg. Assigning timeslots and ticket types to it

List Locations

GET /locations

You can use this endpoint to retrieve a list of locations.

Time Slot

A time slot holds information regarding a specific time slot for tickets.

List Time Slots for Location

GET /locations/:locationId/time-slots/:dateQuery

You can use this endpoint to retrieve a list of time slots. You can query the date with the following formats:YYYY,YYYY-MM,YYYY-MM-DD

Pagination

When querying for a list of objects, you will receive a format like this:

{
  "total": 15646,
  "list": [
    {
      "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f",
      ...
    },
    ...
  ]
}

Wheretotalis the total number of objects that are available andlistis the list of objects that are returned. The limit is 1000 objects per request. So in the above response there are 15646 objects available, but only 1000 are returned. If you want the next 1000 objects, you can use theoffsetparameter.

Querying

To query a list of objects, you can use thefilterparameter. Thefilterparameter is a uri encoded JSON object, where you can specify the fields you want to query.

The base filter is an object like this:

{
  "operator": "CONTAINS",
  "fieldName": "NAME",
  "value": "John"
}

So if you want to run this filter on aCustomer, then you need to stringify the object and uri encode it. The result will be:

%7B%22operator%22%3A%22CONTAINS%22%2C%22fieldName%22%3A%22NAME%22%2C%22value%22%3A%22John%22%7D

And this needs to be appended to the request, which will look like this:

GET
https://api.loby.io/v1/customers?filter=%7B%22operator%22%3A%22CONTAINS%22%2C%22fieldName%22%3A%22NAME%22%2C%22value%22%3A%22John%22%7D

Below are the types foroperator: | Operator | Description | | - | - | |CONTAINS| The field contains the value | |NOT_CONTAINS| The field does not contain the value | |EQUAL| The field is equal to the value | |NOT_EQUAL| The field is not equal to the value | |STARTS_WITH| The field starts with the value | |ENDS_WITH| The field ends with the value | |INCLUDES| The field includes the value | |NOT_INCLUDES| The field does not include the value | |LESSER| The field is lesser than the value | |LESSER_OR_EQUAL| The field is lesser than or equal to the value | |GREATER| The field is greater than the value | |GREATER_OR_EQUAL| The field is greater than or equal to the value | |AND| Use this operator if you want to nest conditions and check that all sub conditions are true | |OR| Use this operator if you want to nest conditions and check that at least one is true |

ThefieldNameis the field you want to query. The available fields are listed in the resource documentation for each resource.

Nested fields

Some fields refer to other resources. E.g.MEMBERSHIPonCustomerrefers to aMembership. In this case you can query the nested fields by using the.notation. E.g. if you want to query theVALID_TOfield on theMembershipfrom the customer you can do it like this:

{
  "operator": "GREATER",
  "fieldName": "MEMBERSHIP.VALID_TO",
  "value": 1646071663704
}

Multiple conditions

If you want to query multiple conditions, you can use theANDorORoperator. E.g. if you want to query all customers that have a membership that is valid for more than 1 month, you can do it like this:

{
  "operator": "AND",
  "conditions": [
    {
      "operator": "GREATER",
      "fieldName": "MEMBERSHIP.VALID_TO",
      "value": 1646071663704
    },
    ...
  ]
}

You can also nest each condition infinitely and also combineANDandORoperators.

Images

Loby provides a fully functional image generator, that dynamically generates images for requested sizes. The images are quickly generated and cached for fast reuse.

Url format

Use the following url for generating images:

https://img.loby.io/{{imageId}}_{{sizingType}}{{size}}.{{format}}

Example

https://img.loby.io/6ef7d631-b898-40a4-ba27-b8c772f6db03_w1280.jpg

QR Code Specification