@wireapp/api-client
v27.95.0
Published
Wire API Client to send and receive data.
Downloads
13,301
Maintainers
Keywords
Readme
Wire
This repository is part of the source code of Wire. You can find more information at wire.com or by contacting [email protected].
You can find the published source code at github.com/wireapp.
For licensing information, see the attached LICENSE file and the list of third-party licenses at wire.com/legal/licenses/.
API Client
Wire for Web's API client.
Getting Started
yarn
yarn startInstallation
yarn add @wireapp/api-clientUsage
Wire Backend
import {APIClient} from '@wireapp/api-client';
import {LoginData} from '@wireapp/api-client/lib/auth/';
import {ClientType} from '@wireapp/api-client/lib/client';
const credentials: LoginData = {
clientType: ClientType.TEMPORARY,
email: '[email protected]',
password: 'top-secret',
};
const apiClient = new APIClient();
apiClient.login(credentials);Custom Backend
import {APIClient} from '@wireapp/api-client';
import {Config} from '@wireapp/api-client/lib/Config';
import {LoginData} from '@wireapp/api-client/lib/auth/';
import {ClientType} from '@wireapp/api-client/lib/client';
const credentials: LoginData = {
clientType: ClientType.TEMPORARY,
email: '[email protected]',
password: 'top-secret',
};
const apiConfig: Config = {
urls: {
name: 'My custom backend',
rest: 'https://backend-rest.domain.com',
ws: 'wss://backend-websocket.domain.com',
},
};
const apiClient = new APIClient(apiConfig);
apiClient.login(credentials);Examples
Browser
Node.js
Execution
Bash
#!/bin/bash
EMAIL="[email protected]"
PASSWORD="password"
node index.js --e="$EMAIL" --p="$PASSWORD"Node
npm run dist
node index.js --e="[email protected]" --p="password"