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

NaviStone Clients API

Client management

NaviStone Clients API is one of 8 APIs that NaviStone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://docs.navistone.com.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://docs.navistone.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NaviStone Clients API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (api-key).

  • api-key — API Key for authentication

Paths & Operations 5

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

Clients 5

Client management

POST
/api/clients
Create a new client
ClientsController_create body → 201400401500
GET
/api/clients
Get all clients
ClientsController_findAll 4 params → 200401500
GET
/api/clients/{id}
Get client by ID
ClientsController_findOne 1 param → 200401404500
PATCH
/api/clients/{id}
Update client
ClientsController_update 1 param body → 200400401404500
DELETE
/api/clients/{id}
Disable client
ClientsController_remove 2 params → 204401404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ClientResponseDto (6 properties), UpdateClientDto (3 properties), CreateClientDto (3 properties). Each schema is shown below with its type and property counts.

ClientResponseDto
object
6 properties 6 required
CreateClientDto
object
3 properties 1 required
UpdateClientDto
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

navistone-clients-api-openapi.yml Raw ↑

Other APIs NaviStone publishes across the network.

NaviStone API Info API
NaviStone Campaigns API
NaviStone Domains API
NaviStone Geo Targeting API
NaviStone Health API
NaviStone Output API
NaviStone Segments API