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 Connections API

The Connections API from Nayya — 2 operation(s) for connections.

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

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

This API exposes 3 operations across 2 paths, and defines 7 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.

3 operations 2 paths 7 schemas 1 DELETE2 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 Connections 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 3

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

Connections 3
POST
/connections
Add connections to an Account
add-connections 1 param body → 201400403404409422500
POST
/employers/{employerId}/connections
Add connection to an Employer
add-connection-to-employer 2 params body → 200400403404500
DELETE
/employers/{employerId}/connections
Remove connection from an Employer
remove-connection-from-employer 2 params body → 200400403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are EmployerResponseDto (16 properties), ConnectionDto (4 properties), ConfiguredConnectionsResponseDto (4 properties), ConnectionConfigDto (2 properties). Each schema is shown below with its type and property counts.

AddConfiguredConnectionsDto
object
1 property 1 required
AddConnectionDto
object
1 property 1 required
EmployerResponseDto
object
16 properties 16 required
ConfiguredConnectionsResponseDto
object
4 properties 4 required
ConnectionDto
object
4 properties 1 required
RemoveConnectionDto
object
1 property 1 required
ConnectionConfigDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-connections-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

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