Developer API - Getting Started

The Little Aspen Developer API uses REST architectural style. The API endpoints are human-readable resource-oriented URLs, always using HTTPS and the data is always returned as JSON responses. All endpoints require authentication via Bearer API key.

Little Aspen API follows OpenAPI Specification (formerly Swagger Specification) to describe all available endpoints, operation parameters for input and output, and authentication methods.

To intregrate Little Aspen into your application is a simple process:

  1. Create your Little Aspen account;
  2. Generate an API Key;
  3. Make API requests;

1. Create your Little Aspen account

If you already have an account you can skip this step or you can sign up for free.

2. Generate an API Key

All requests to the Little Aspen API are authenticated using an API Key that identifies your account. The Little Aspen API will return an authentication error in case you don't include the API Key or if the API Key is expired or invalid.

All the API Keys under your account can be found in API Keys, where you can manage the API keys and generate new ones.

3. Make API requests

Once you have a valid API Key you can use it as part of the API requests. Here is an example using cURL of an API request to list all documents under an account.

You can also explore the full API resources in our Interactive API Documentation.

Request Example

API Base URL:

https://www.littleaspen.com/api

Authorization Header:

Authorization: Bearer your-api-key-here

Full Request:

curl -X GET "https://www.littleaspen.com/api/documents" \
     -H "Authorization: Bearer pggyc7lqusq7qvkmttunirybmpbozob2r6jbll5hqeup3ur3rh5q"

Response Example

The response data returned is in JSON as below:

{
  "data": {
    "documents": [
      {
        "id": "c01afe5a-9d89-4a4c-bb4b-3e34cacb31e2",
        "inserted_at": "2020-04-12T12:34:55Z",
        "slug": "privacy-policy",
        "title": "Privacy Policy",
        "updated_at": "2020-04-12T12:34:55Z",
        "user_id": "1195bbcb-a307-4170-8cd4-9fd5f4ee0c02"
      }
    ]
  }
}