API Reference

The Nacelle API includes both HTTP REST APIs and GraphQL APIs. The HTTP APIs use predictable resource-oriented URLs to call the API, uses standard HTTP status codes to indicate the success or failure of requests, and returns JSON from all requests. The GraphQL APIs enable streamlined and expressive data queries and resource mutations while optimizing network efficiency.

Use the Nacelle APIs to access the entire Nacelle platform programmatically.

REST API

Nacelle's REST APIs include:

GraphQL API

Nacelle's GraphQL APIs include:

Authentication

Data Ingestion and Orchestration

To authenticate to the Data Ingestion API, you need these headers:

x-nacelle-space-id- To find the Space ID, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > find the x-nacelle-space-id in the Space ID section.
x-nacelle-source-id- To find the Source ID, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > find the x-nacelle-source-id under Source ID for your app in the Data Ingest API section.
x-nacelle-ingest-token- To create an Ingest Token, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > click the Create a New Key button under Private Token in the Data Ingest API section. The key will only be displayed once, so be sure to save it in a secure location.

Checkout, Order Management, and Admin APIs

OAuth 2.0 is an industry-standard protocol for secure authorization. It allows third-party services to access resources on behalf of a user without exposing the user's password. OAuth 2.0 provides a robust and flexible framework to grant permissions in a way that is secure, standardized, and easy for end-users to understand and control.

OAuth access tokens are used to maintain secure access to Nacelle APIs.

To find the Orders API access token, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > click the Generate Credential button in the Orders API section. The key will only be displayed once, so be sure to save it in a secure location. If you are not seeing this token, contact your CSM to request access.

You can also programmatically generate an access token by using the Create a Nacelle Credential API.

For more information, see Client Credentials on how to setup credentials for your space. See Access Tokens for information on generating an access token using your credentials.

Storefront GraphQL API

Use the Storefront API to export normalized data from Nacelle. The Storefront API also uses a OAuth access token. To find the Storefront API access token, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > click the Create a New Key button under Preview Token in the Storefront API section. The key will only be displayed once, so be sure to save it in a secure location.