Usage sequence diagram

Open the following Sequence Diagram to get an overview of the usage of our API.

Authorization

Please contact the Mobuy Support to obtain an access token.

Every request needs to contain the bearer token in the header like:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...

Pagination

API services that may potentially return a lot of data implement pagination. They return a limited number of entries within a "page". Further entries must be fetched with subsequent calls.

Any API service that implements pagination provides the following input parameters:
• "page": the number of the page to be retrieved (starting with 1).
• "pageSize": the number of entries within a page. The default value is 100, the maximum 1000.

A paged response contains an "items" field that stores the single response items as an array and also the following structure:

{
  "items": [
    . . .
  ],
  "page": 1,
  "pageSize": 10,
  "total": 999,
  "count": 10,
  "pages": 99
}
"page" being the current page, "pageSize" the number of items to be returned for each page, "total" the total count of items in the database, "count" the number of items returned in the current page, "pages" the total number of pages withing the current pagination settings.

Client Code Generation

Select the client type you want from the dropdown list and press "Download SDK" or go to the OpenAPI online generator.