README

Public API for WhatPulse user data access. This API allows authenticated users to access their own data and public data from other users, depending on privacy settings.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, run:

composer require whatpulse/api-sdk-php

API Key

To use the WhatPulse API, you'll need an API key. You can generate one by visiting: https://whatpulse.org/go/settings-api-keys

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: http
$config = WhatPulse\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new WhatPulse\Api\ComputersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | User ID or username
$is_archived = 'is_archived_example'; // string | Get filter parameters

try {
    $result = $apiInstance->v1UsersComputers($id, $is_archived);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComputersApi->v1UsersComputers: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://whatpulse.org/api/v1

Class	Method	HTTP request	Description
ComputersApi	v1UsersComputers	GET /users/{id}/computers	Get user computers
MembersApi	v1TeamsMembers	GET /teams/{team_id}/members	Get team members
ProfilesApi	v1UsersProfiles	GET /users/{id}/profiles	Get user profiles
PulsesApi	v1UsersPulses	GET /users/{id}/pulses	Get user pulses
SubteamMembersApi	v1TeamsSubteamsMembers	GET /teams/{team_id}/subteams/{subteam_id}/members	Get subteam members
SubteamsApi	v1TeamsSubteams	GET /teams/{team_id}/subteams	Get team subteams
SubteamsApi	v1TeamsSubteamsShow	GET /teams/{team_id}/subteams/{subteam_id}	Get subteam details
TeamsApi	v1TeamsIndex	GET /teams	Search teams
TeamsApi	v1TeamsShow	GET /teams/{team_id}	Get team details
TimeSeriesApi	v1UsersTimeSeries	GET /users/{id}/time-series	Get user time series
UsersApi	v1UsersIndex	GET /users	Search users
UsersApi	v1UsersShow	GET /users/{id}	Get user details

Models

Authorization

Authentication schemes defined for the API:

http

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

whatpulse / api-sdk-php

Maintainers

Details