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

Nayya Snapshots API

The Snapshots API from Nayya — 1 operation(s) for snapshots.

Nayya Snapshots API is one of 11 APIs that Nayya publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against 2 base URLs: https://integrate.nayya.com/accounts, https://integrate.partners.nayya.com/accounts.

1 operations 1 paths 18 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://integrate.nayya.com/accounts
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nayya Snapshots API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Snapshots 1
POST
/employers/{employerId}/employees/{employeeId}/snapshot
Create a Snapshot
create-snapshot 3 params body → 201403422429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are SnapshotBenefitResponseDto (19 properties), RatePackageResponseDto (9 properties), CreateSnapshotResponseDto (8 properties), TierResponseDto (7 properties). Each schema is shown below with its type and property counts.

SnapshotBenefitResponseDto
object
19 properties 10 required
RatePackageDependencyResponseDto
object
4 properties 4 required
TierResponseDto
object
7 properties 6 required
CreateBenefitRequestDto
object
4 properties 1 required
BenefitDependencyResponseDto
object
6 properties 4 required
LabelResponseDto
object
5 properties 5 required
CreateRatePackageRequestDto
object
6 properties 4 required
FeatureItemResponseDto
object
7 properties 3 required
ThresholdResponseDto
object
6 properties 6 required
CreateRatePackageFamilyRoleRequestDto
object
2 properties 1 required
RatePackageResponseDto
object
9 properties 9 required
CreateSnapshotResponseDto
object
8 properties 8 required
CreateSnapshotRequestDto
object
2 properties 2 required
RatePackageFamilyRoleResponseDto
object
5 properties 4 required
NayyaRulePropertiesDto
object
2 properties 2 required
FeatureResponseDto
object
7 properties 6 required
ThresholdItemResponseDto
object
6 properties 3 required
CreateRatePackageDependencyRequestDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-snapshots-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

Nayya Benefits API
Nayya Carriers API
Nayya Connections API
Nayya Dependents API
Nayya Employees API
Nayya Employers API
Nayya Enrollments API
Nayya Recommendations API
Nayya Rule Templates API
Nayya Token API