Introduction

Welcome to the CheckMaxx Check API !

You can use our API to access endpoints, which gives read/write to CheckMaxx checklists.

Endpoints description, method, url, request/response schema and their description are presented on the left. The right side contains example requests (via curl) and responses (in JSON).

For more information on types and possible value, refer to the Models and Enumeration section.

In the future, more endpoints will be added in order to provide complete access to CheckMaxx database.

If this is your first time reading the docs, check out the Authentication section for obtaining and using API keys.

Changelog section contains all updates related to this API.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: $your_api_key"

CheckMaxx API uses API keys to allow access to the API... You can receive a new API key by logging in, and it will be provided as a session token.

Check Service CheckMaxx Controller

CheckMaxx controller for creating and retrieving checklists.

The Check Service CheckMaxx Controller API provides endpoints for managing CheckMaxx checklists. It allows seamless creation and retrieval of checklists, enabling efficient checklist management.

Creates a Checkmaxx

curl "API_BASE/v1/checkmaxxs/create"
    -H "Authorization: $your_api_key"

This endpoint create a Checkmaxx and send the PDF to the user.

HTTP Request

POST /v1/checkmaxxs/create

The request Body payload is:

{
    "checkmaxx": {
        "created_on": "0001-01-01T00:00:00Z",
        "id": 0,
        "checkable_id": 0,
        "checked_id": 0,
        "shop_id": 0,
        "created_by": 0,
        "shop": null,
        "checked": null,
        "items": null
    }
}

The request JSON response is:

{
    "id": 0
}

Request schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Upload a checked photo

curl "API_BASE/v1/checkmaxxs/upload_checked_photo"

This endpoint upload a picture and return it's URL to be used as checked.photo_url.

HTTP MultiPart Request

POST /v1/checkmaxxs/upload_checked_photo

The request parts are:

--XXX
Content-Disposition: form-data; name=

...
--XXX
Content-Disposition: form-data; name=

...--XXX--

The request JSON response is:

{
    "photo_url": "",
    "thumbnail_url": ""
}

This request must be a multipart/form-data content-type with valid boundary for each part

Request parts schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Upload an item photo

curl "API_BASE/v1/checkmaxxs/upload_item_photo"

This endpoint upload a picture and return it's URL to be used as item.photo_url.

HTTP MultiPart Request

POST /v1/checkmaxxs/upload_item_photo

The request parts are:

--XXX
Content-Disposition: form-data; name=

...
--XXX
Content-Disposition: form-data; name=

...--XXX--

The request JSON response is:

{
    "photo_url": "",
    "thumbnail_url": ""
}

This request must be a multipart/form-data content-type with valid boundary for each part

Request parts schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Read a Checkmaxx

curl "API_BASE/v1/checkmaxxs/read"
    -H "Authorization: $your_api_key"

This endpoint return a created CheckMaxx via a private key.

HTTP Request

POST /v1/checkmaxxs/read

The request Body payload is:

{
    "key": ""
}

The request JSON response is:

{
    "checkmaxx": null
}

Request schema

Response schema

This endpoint return an object with the following fields, please refer to the JSON response column on the right for an example.

Models and Enumeration

Checkable Enumeration

ItemCategory Enumeration

ItemType Enumeration

ShopTier Enumeration

CheckMaxx[interface {}] Model

Checked[interface {}] Model

FormFile Model

Item[interface {}] Model

Shop Model

Changelog

This section contains changes related to the API service. Changes will be included if:

• A new endpoint is added
• A new field is added to an existing endpoint
• Field description changes
• A field is deprecated

Initial release - 08.06.2023.

The following endpoints are included with initial release:

• /v1/checkmaxx/create

Errors

CheckMaxx APIs uses the following error codes: