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

CAMARA Project Discovery API

Find the closest Edge Cloud Zone to the user device.

CAMARA Project Discovery API is one of 30 APIs that CAMARA Project publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Discovery. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version wip.

Requests are made against a single base URL, {apiRoot}/call-forwarding-signal/vwip.

1 operations 1 paths 16 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Server
{apiRoot}/call-forwarding-signal/vwip
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

CAMARA Project Discovery API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — to support Consent Management

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.

Discovery 1

Find the closest Edge Cloud Zone to the user device.

POST
/retrieve-closest-edge-cloud-zone
Returns the name of the Edge Cloud Zone closest to user device identified in the request.
readClosestEdgeCloudZone 1 param body → 200400401403404422429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), ErrorInfo (3 properties), DeviceIpv4Addr (3 properties), EdgeCloudZone (3 properties). Each schema is shown below with its type and property counts.

EdgeCloudZoneId
string
Operator-issued UUID for the Edge Cloud Zone.
EdgeCloudProvider
string
The company name of the Edge Cloud Zone provider.
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…
DeviceResponseBody
object
The optional device identifier to include in the response
1 property
XCorrelator
string
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DeviceIpv4Addr
object
The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (o…
3 properties
EdgeCloudZoneName
string
Edge Cloud Zone Name - the common name for the Edge Cloud Zone.
ErrorInfo
object
Error information
3 properties 3 required
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
EdgeCloudZone
object
An Edge Cloud Zone, uniquely identified by a combination of the value of the Edge Resource Name object and the value of the Provider object (the name of the cl…
3 properties 3 required
Port
integer
TCP or UDP port number
Device
object
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide t…
4 properties
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…
RequestBody
object
Common request body to allow optional Device object to be passed
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-discovery-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
CAMARA Project Call Forwarding information retrieval API
CAMARA Project Check Device Swap API
CAMARA Project Check SIM swap API
CAMARA Project Connected Network Type API
CAMARA Project Device reachability status API
CAMARA Project Fill-in API
CAMARA Project Geofencing subscriptions API
CAMARA Project Home Devices QoD API
CAMARA Project Location retrieval API
CAMARA Project Location verification API
CAMARA Project Match API