Lauded Docs

# API

# Authorization

Lauded uses both access token and api granted special code (API Key) to authorize requests. The API Key is typically used to authorize frontend application. For example when accessing reviews for the widgets.

API Key for your business can be found on the integration tab in company account settings.

Backend applications can utilize the Lauded Integration (opens new window) to make authorization easier. Refer to the readme file of this package to know more.

# Environments

Lauded API is available in both production and sandbox environment. You can test your integrations against the sandbox enviroment and use the production environmnent when you move your application to production.

# Sandbox environment

Sandbox environment is available at https://api.lauded.dev (opens new window)

# Production environment

Production environment is available at https://api.lauded.io (opens new window)

# Rate Limiting

All requests to the API are limited by default to 100 requests per minute.

# Pagination

All API results are by default paginated to 10 records per page. This number can be adjusted using the items_per_page parameter

Pagination can be found in the link object in the response.

"links": {
    "prev": null,
    "next": "https://api.lauded.io/api/client/reviews?page=2&items_per_page=10",
    "first": "https://api.lauded.io/api/client/reviews?page=2&items_per_page=10",
    "last": "https://api.lauded.io/api/client/reviews?page=10&items_per_page=10"
}

# Requests

Body parameters in the docs usually have validation rule or abbreviations associated with them. Here's what they mean;

# optional

Property must either be missing from the body payload or in valid format specified by other validation rules.

# Success response

Success response comes in the following format with 2XX HTTP status code.

{
    "data": "array or object"
}

# Error response

Error response comes in the following format with 4XX HTTP status code

{
    "error": "error message",
    "errorCode": "optional error code"
}

← Access Token →