@snap/camera-kit/docs/md/interfaces/RemoteApiService.md

Camera Kit Web

[**CameraKit Web SDK v1.13.0**](../README.md)

***

[CameraKit Web SDK](../globals.md) / RemoteApiService

# Interface: RemoteApiService

Service to handle a lens Remote API request.

## Properties

### apiSpecId

> **apiSpecId**: `string`

Remote API spec ID(s).

## Methods

### getRequestHandler()

> **getRequestHandler**(`request`, `lens`): `undefined` \| [`RemoteApiRequestHandler`](../type-aliases/RemoteApiRequestHandler.md)

This method is called by Camera Kit when a lens triggers a Remote API request with a corresponding spec ID.
If the service can handle the request, the method returns a request handler; otherwise, it returns nothing.

#### Parameters

##### request

[`RemoteApiRequest`](RemoteApiRequest.md)

Remote API request object.

##### lens

[`Lens`](Lens.md)

Lens that triggers the request.

#### Returns

`undefined` \| [`RemoteApiRequestHandler`](../type-aliases/RemoteApiRequestHandler.md)

A request handler if applicable.