Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NCR Site API

Site (location) provisioning, lookup, and geospatial search.

NCR Site API is one of 7 APIs that NCR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Site. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and code examples.

This API exposes 6 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.ncr.com, https://gateway-staging.ncrcloud.com.

6 operations 5 paths 7 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ncr.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NCR Site API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmacAccessKey). By default, every request must be authenticated.

  • hmacAccessKey — AccessKey (HMAC) authentication. The Authorization header carries "AccessKey {sharedKey}:{signature}", where the signature is a Base64 SHA-512 HMAC computed ov…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Site 6

Site (location) provisioning, lookup, and geospatial search.

POST
/site/sites
NCR Voyix Create Site
createSite body → 201
GET
/site/sites/{siteId}
NCR Voyix Get Site by Id
getSiteById 1 param → 200404
PUT
/site/sites/{siteId}
NCR Voyix Update Site
updateSite 1 param body → 200
POST
/site/sites/find-by-criteria
NCR Voyix Find Sites by Criteria
findSitesByCriteria 1 param body → 200
GET
/site/sites/find-nearby/{coordinates}
NCR Voyix Find Nearby Sites
findNearbySites 3 params → 200
GET
/site/sites/by-reference-id/{referenceId}
NCR Voyix Get Site by Reference Id
getSiteByReferenceId 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SiteInput (8 properties), Address (5 properties), Error (2 properties), SiteSearch (2 properties). Each schema is shown below with its type and property counts.

Site
Address
object
5 properties
Status
string
SiteInput
object
8 properties 3 required
Coordinates
object
2 properties
SiteSearch
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncr-site-api-openapi.yml Raw ↑

Other APIs NCR publishes across the network.

NCR Catalog API
NCR Category API
NCR Order API
NCR Provisioning API
NCR Security API
NCR Selling API