Key

Check that a key works, and for which catalog.

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

Endpoints

get/pingCheck the key

get/ping

Check the key

Which company, catalog and key the request is authenticated as, and the server time.

GET https://api-catalog.nucleoplatform.com/api/catalog/v1/ping

Authentication: Bearer token

Rate limit: 600 requests per 1m, per key (default; the catalog owner can set 1–6,000)

Responses

200The key works.application/json
- dataPingrequired
  Child attributes
  api_version"v1"
  companyobject
  Child attributes
  idinteger | null
  catalogobject
  Child attributes
  idinteger
  namestring
  keyobject
  Child attributes
  idstring (uuid)
  namestring
  levelstring
  One ofreadwrite
  field_rulestring
  sorgente: the API always updates the fields it sends. People in Nucleo can no longer edit the products it wrote. inserimento: the API only fills fields that are empty in Nucleo. nucleo: the API does not change existing fields.
  
  One ofsorgenteinserimentonucleo
  rate_limit_per_minuteinteger
  webhooksinteger
  Active webhooks of this key.
  
  server_timestring (date-time)
401unauthorized: the key is missing, wrong or revoked.application/json
- errorobjectrequired
  Child attributes
  codestringrequired
  Stable machine-readable code. Branch on it, not on the message.
  
  messagestringrequired
  request_idstringrequired
  Same as the X-Request-Id header. Quote it to support.
  
  detailsobject
429rate_limited: wait the seconds in Retry-After.application/json
Headers
- Retry-After Seconds to wait.
- errorobjectrequired
  Child attributes
  codestringrequired
  Stable machine-readable code. Branch on it, not on the message.
  
  messagestringrequired
  request_idstringrequired
  Same as the X-Request-Id header. Quote it to support.
  
  detailsobject

Request

curl -X GET https://api-catalog.nucleoplatform.com/api/catalog/v1/ping \
  -H "Authorization: Bearer $NUCLEO_ACCESS_TOKEN" \
  -H 'Accept: application/json'

const res = await fetch("https://api-catalog.nucleoplatform.com/api/catalog/v1/ping", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.NUCLEO_ACCESS_TOKEN}`,
    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/catalog/v1/ping', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('NUCLEO_ACCESS_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false,
]);

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

Response

{
  "data": {
    "api_version": "v1",
    "company": {
      "id": 12
    },
    "catalog": {
      "id": 4,
      "name": "Acme"
    },
    "key": {
      "id": "9b2f1c6e-3a4d-4f5e-8a7b-1c2d3e4f5a6b",
      "name": "ERP sync",
      "level": "write",
      "field_rule": "sorgente",
      "rate_limit_per_minute": 600
    },
    "webhooks": 1,
    "server_time": "2026-10-14T08:00:00Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "details": {}
  }
}

Was this page helpful?