Skip to main content

API documentation (0.3.0)

The Enterspeed API are based on REST principles.

Before you start you will need to create an Enterspeed-account and set up a tenant (a property for your website). Here you can create

  • A data source (provides you with an API key for the Ingest API).
  • An environment client (provides you with an API key for the Delivery API).
  • A domain (ensure the correct data gets fetched).

🎉 Have fun using our API. Make sure to contact us if you need any help. We're happy assist!

Delivery

The Delivery API is what you use to GET your data from Enterspeed to your frontend project. Before you can fetch your content from Enterspeed, you first need to create an Environment client which generates an API key. This is done under Settings --> Environment settings.

You can find an example of how to fetch data Umbraco & Next.js tutorial.

Get content by URL, IDs, or handle

query Parameters
url
string
Default: ""
Example: url=https://enterspeed.com/about-us/

The URL to get data from.

Maximum: 1
Required: false

id
string
Default: ""
Example: id=gid://Environment/f0edd7b7-23dd-4177-a98a-313127601e97/Source/32ebdcab-ae19-4a71-a09e-a93257b807b7/Entity/4573/ContentPage

Specific guids to get data from.

Maximum: unlimited
Required: false

handle
string
Default: ""
Example: handle=Navigation

Specific handles to get data from. Handles will be returned in the views object and must be unique.

Maximum: unlimited
Required: false

header Parameters
X-Api-Key
string
Example: environment-1637c4d0-e878-4738-b866-152106a4f88c

Api key to validate your environment.

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "route": {
    },
  • "views": {
    }
}

Ingest

The Ingest API is used to POST your current data sources into Enterspeed. Before you can start ingesting data, you'll need to create a Data source inside Enterspeed, which generates an API key. This is done under Settings --> Data sources.

The Ingest API can also be used to DELETE already ingested data from Enterspeed.

Save entity

Starting the process for saving the entity.

This endpoint can be used in two ways:

  • Raw: The body contains the raw source entity and the required meta data is provided as header parameters.
  • Simplified: The source entity is given properties of the body which also includes meta data.
path Parameters
originId
required
string
Example: 1

Id of the entity. Must be same format for all entities within the same source. Eg. integers, guids, etc.

header Parameters
X-Api-Key
required
string
Example: source-90880177-e9a1-47b3-9a40-7b728a6bafd8

Api key to validate your source.

X-Enterspeed-Type
string
Example: product

The type or alias of the type of entity being send to process. Eg. blogList, blogPage, frontPage, etc. Only used for raw body

X-Enterspeed-Url
string
Example: /product-1

If the entity is routable send the URL. Skip if entity is not routable. Only used for raw body

X-Enterspeed-OriginParentId
string
Example: 2

Allowed as null if no hierarchy exists. Only used for raw body

X-Enterspeed-Redirects
string
Example: /product-old,/product-very-old

Comma separated list of URLs that redirects to the current page. Eg. https://enterspeed.com/product-1-old/ redirecting to https://enterspeed.com/product-1/.

Request Body schema: application/json

The entity to process

One of
string or number or boolean or array or object

Property names:

  • cannot start with a digit
  • cannot consist only of underscores
  • can contain A-Z, a-z letters, digits and underscores
Any of
string

Property names:

  • cannot start with a digit
  • cannot consist only of underscores
  • can contain A-Z, a-z letters, digits and underscores

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Official Enterspeed T-shirt",
  • "price": 199.99,
  • "inStock": true,
  • "features": [
    ],
  • "information": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Processing entity has begun"
}

Delete entity

Starting the process for deleting the entity.

path Parameters
originId
required
string
Example: 1234

The entity id to delete

header Parameters
X-Api-Key
string
Example: source-90880177-e9a1-47b3-9a40-7b728a6bafd8

Api key to validate your source.

Responses

Routes

The routes API is what you use to GET all available routes for a specific environment, which can be helpful for SSG (Static Site Generation) or creating a sitemap.

Before you can fetch your routes from Enterspeed, you first need to create an Environment client which generates an API key. This is done under Settings --> Environment settings.

Get Routes

Get all the routes for a specific environment.

query Parameters
first
number
Example: first=100

Get the first of the paginated list, aka. get the list in ascending order.

last
number
Example: last=100

Get the last of the paginated list, aka. get the list in descending order.

before
number

The cursor to get data before, eg. previous page.

after
number

The cursor to get data after, eg. next page.

header Parameters
X-Api-Key
string
Example: environment-1637c4d0-e878-4738-b866-152106a4f88c

Api key to validate your environment.

Responses

Response samples

Content type
application/json
{
  • "total": 16,
  • "pageInfo": {
    },
  • "results": [
    ]
}