Installation

Connectivity check for the installation behind a public key.

Base URL, authentication and conventions of this API are on the Collector API page.

Endpoints

get/configCheck the installation is connected

get/config

Check the installation is connected

Returns the installation behind the key: the script uses it to know it is connected, and you can open it from the browser address bar while testing. For this GET the origin is taken from Origin, or from Referer when Origin is absent. A paused installation answers 403.

Rate limits. Shared with all Collector operations: 120 requests per minute per IP, 20,000 per minute per key.

GET https://api-catalog.nucleoplatform.com/api/collect/v1/config

Authentication: key query parameter or X-Nucleo-Key header

Rate limit: 120 requests per 1m, per IP

Headers

Originstringrequired
Required. Browsers set it; servers and tools must send it (on GET, Referer is accepted instead). Its host must equal one of the installation's domains, or be a subdomain of a wildcard domain (*.acme.example matches shop.acme.example and eu.shop.acme.example, not acme.example). A wildcard must sit under your own registrable domain: it is refused on a public suffix (*.com, *.co.uk) and on shared platforms where every subdomain belongs to someone else (for example *.myshopify.com, *.vercel.app, *.netlify.app, *.github.io); such a wildcard saved earlier matches nothing. Register those hosts by their exact name. null is accepted only when the installation has the Web Pixel enabled. An origin that does not match answers 403.

Example: https://shop.acme.example
Refererstring
On GET operations only, used for the origin check when Origin is absent.

Example: https://shop.acme.example/products/classic-tee-black

Responses

200The installation is active and the origin is allowed.application/json
Headers
- Access-Control-Allow-Origin Echoes the request Origin when it was present and allowed.
- Vary Always Origin.
- oktruerequired
- storestringrequired
  Store slug.
  
  Example: acme
- installationstringrequired
  Installation name.
  
  Example: Acme EU storefront
- statusstringrequired
  Always active (a paused installation answers 403).
  
  One ofactive
- localesarray of stringrequired
- pixelEnabledbooleanrequired
  Whether Origin: null (the checkout Web Pixel) is accepted.
403The installation is paused, or the origin is not one of its domains. Both answer the same body; the exact reason is visible to the merchant in Catalog › Shoppers › Test events. application/json
- messagestringrequired
404The key is missing, malformed or unknown (no detail is given on purpose).application/json
- messagestringrequired
409The store behind the key is not provisioned yet.application/json
- messagestringrequired
429Rate limit exceeded (120 requests per minute per IP, or 20,000 per minute per key). Nothing is written. application/json
Headers
- Retry-After Seconds to wait before retrying.
- X-RateLimit-Limit Requests allowed per minute for the client IP.
- X-RateLimit-Remaining Always 0 on a 429.
- X-RateLimit-Reset Unix timestamp at which the window resets.
- messagestringrequired

Request

curl -X GET "https://api-catalog.nucleoplatform.com/api/collect/v1/config?key=$NUCLEO_COLLECTOR_KEY" \
  -H 'Origin: https://shop.acme.example' \
  -H 'Referer: https://shop.acme.example/products/classic-tee-black' \
  -H 'Accept: application/json'

const res = await fetch(`https://api-catalog.nucleoplatform.com/api/collect/v1/config?key=${process.env.NUCLEO_COLLECTOR_KEY}`, {
  method: "GET",
  headers: {
    Origin: "https://shop.acme.example",
    Referer: "https://shop.acme.example/products/classic-tee-black",
    Accept: "application/json",
  },
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-catalog.nucleoplatform.com/api/collect/v1/config?key=' . getenv('NUCLEO_COLLECTOR_KEY'), [
    'headers' => [
        'Origin' => 'https://shop.acme.example',
        'Referer' => 'https://shop.acme.example/products/classic-tee-black',
        'Accept' => 'application/json',
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

Response

{
  "ok": true,
  "store": "acme",
  "installation": "Acme EU storefront",
  "status": "active",
  "locales": [
    "it",
    "en"
  ],
  "pixelEnabled": true
}

{
  "message": "Forbidden."
}

{
  "message": "Not found."
}

{
  "message": "Store is not ready."
}

{
  "message": "Too Many Attempts."
}

Was this page helpful?