Nuvelics documentation
APIAPI reference

CMS connections

Connect your content management systems, and list the places a web article can be filed into.

List CMS connections for the organization

GET
/api/tenant/v1/cms-configs

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Response Body

Every CMS connection configured for the organization.

application/json
  1. response
items*array<|>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/cms-configs'
Example Response
{  "items": [    {      "id": "string",      "orgId": "string",      "displayName": "string",      "credentialId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "vendor": "arc_xp",      "arcOrgId": "string",      "environment": "production",      "websiteId": "string"    }  ]}

Create a CMS connection

POST
/api/tenant/v1/cms-configs

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Request Body

application/json
  1. body

Arc XP CMS connection

displayName*string

CMS connection display name

Length1 <= length
vendor*"arc_xp"
Value in"arc_xp"
arcOrgId*string

Arc organization id — the {org-id} in the API host, and each story's owner.id

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$
environment*string

Arc environment; decides the API host prefix

Value in"production""sandbox""staging""development"
websiteId*string

Site Service Website ID — the target site within the Arc org

Length1 <= length
accessToken*string
Length1 <= length

Response Body

CMS connection created

application/json
  1. response
id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
displayName*string

CMS connection display name

Length1 <= length
credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time
updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time
version*integer

Monotonic row version; used as concurrency token

vendor*"arc_xp"
Value in"arc_xp"
arcOrgId*string

Arc organization id — the {org-id} in the API host, and each story's owner.id

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$
environment*string

Arc environment; decides the API host prefix

Value in"production""sandbox""staging""development"
websiteId*string

Site Service Website ID — the target site within the Arc org

Length1 <= length
Example Request
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/cms-configs' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "string",  "vendor": "arc_xp",  "arcOrgId": "string",  "environment": "production",  "websiteId": "string",  "accessToken": "string"}'
Example Response
{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "arc_xp",  "arcOrgId": "string",  "environment": "production",  "websiteId": "string"}

Get a CMS connection

GET
/api/tenant/v1/cms-configs/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

The CMS connection.

application/json
  1. response
id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
displayName*string

CMS connection display name

Length1 <= length
credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time
updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time
version*integer

Monotonic row version; used as concurrency token

vendor*"arc_xp"
Value in"arc_xp"
arcOrgId*string

Arc organization id — the {org-id} in the API host, and each story's owner.id

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$
environment*string

Arc environment; decides the API host prefix

Value in"production""sandbox""staging""development"
websiteId*string

Site Service Website ID — the target site within the Arc org

Length1 <= length
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/cms-configs/string'
Example Response
{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "arc_xp",  "arcOrgId": "string",  "environment": "production",  "websiteId": "string"}

Update a CMS connection (PATCH-merge)

PATCH
/api/tenant/v1/cms-configs/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Request Body

application/json
  1. body
displayName?string
Length1 <= length
arcOrgId?string
Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$
environment?string
Value in"production""sandbox""staging""development"
websiteId?string
Length1 <= length
accessToken?string
Length1 <= length
siteUrl?string
username?string
Length1 <= length
applicationPassword?string
Length1 <= length
featuredCreditInBody?boolean

Whether a filed article's body starts with the featured image's credit (wordpress). Omitted keeps the stored setting.

Response Body

CMS connection updated

application/json
  1. response
id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string

Owning organization identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
displayName*string

CMS connection display name

Length1 <= length
credentialId*string

Reference to stored credential

createdAt*string

ISO 8601 creation timestamp

Formatdate-time
updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time
version*integer

Monotonic row version; used as concurrency token

vendor*"arc_xp"
Value in"arc_xp"
arcOrgId*string

Arc organization id — the {org-id} in the API host, and each story's owner.id

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$
environment*string

Arc environment; decides the API host prefix

Value in"production""sandbox""staging""development"
websiteId*string

Site Service Website ID — the target site within the Arc org

Length1 <= length
Example Request
curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/cms-configs/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "orgId": "string",  "displayName": "string",  "credentialId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "vendor": "arc_xp",  "arcOrgId": "string",  "environment": "production",  "websiteId": "string"}

Delete a CMS connection

DELETE
/api/tenant/v1/cms-configs/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

CMS connection identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

CMS connection deleted, together with its credential

Example Request
curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/cms-configs/string'
Example Response
Empty

List CMS push targets for the organization

GET
/api/tenant/v1/cms-push-targets

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Response Body

Every CMS connection of the organization, as a push target.

application/json
  1. response
items*array<|>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/cms-push-targets'
Example Response
{  "items": [    {      "id": "string",      "displayName": "string",      "vendor": "arc_xp"    }  ]}

Report a problem with this page

Brand kits

Manage the brand kits that set how your outputs look (colours, typefaces, logo and motion), and find and copy the Google fonts a kit can use.

Connected apps

List and revoke the apps connected to Nuvelics with OAuth, your own or your whole organization's.

On this page

List CMS connections for the organizationCreate a CMS connectionGet a CMS connectionUpdate a CMS connection (PATCH-merge)Delete a CMS connectionList CMS push targets for the organization