API Reference

The Showwcase API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Caching

The Showwcase API utilizes Cache-First approach. In this approach, when a user requests data from the server, the server first checks if the requested data is available in the cache. If the data is available in the cache, the server returns it immediately to the user without making any additional requests to the database.

Supported Methods

Method	Description
GET	Retrieve information about the REST API resource
POST	Create a REST API resource
PUT	Update a REST API resource
DELETE	Delete a REST API resource or related component

Pagination

Most of the lists/item collections are paginated. The parameters that control the pagination are skip and limit, indicating the desired offset and the items per page values.

The maximum limit value is 100.

Response format

Pagination

{
    "payload": [
        {
            "id": 1,
        },
        {
            "id": 2
        }
    ],
    "details": {
        "total": 1000,
        "size:": 100,
        "offset": 100,
        "hasMore": true
    },
}

Single Object

{
    "payload": {
        "id": 1
    },
    "_self": "https://showwcase.com/..."
}

Error

{
    "error": "You cannot request more than 100 items.",
    "code": "RESULT_LIMIT",
    "payload": null
}

HTTP status codes

Here's a list of the status codes used in Showwcase API:

Status Code	Name	Description
200	OK	Request fulfilled
201	Created	New resource created
400	Bad Request	Request not understood
401	Unauthorized	Invalid API token
403	Forbidden	Request not allowed
404	Not Found	Resource unavailable
405	Method not allowed	Incorrect request method
410	Gone	Old resource permanently unavailable
415	Unsupported Media Type	Feature is not enabled
429	Too Many Requests	Rate limit has been exceeded
500	Internal Server Error	Generic server error

Best Practices

We can’t wait to see what you build! And we’d like to encourage you to build it using these recommended best practices.

Avoid unnecessary fetching

If you are frequently fetching the same data from Showwcase API, we recommend moving the data to your own servers.

Know your limits

All of our products have rate limits to ensure that all customers experience a high level of performance when using our platform.

Did we miss something?

Do you have a favorite best practice you’d like to see added to our list? Please let us know!