PHPackages                             smartoysters/saferme-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. smartoysters/saferme-api

ActiveLibrary[API Development](/categories/api)

smartoysters/saferme-api
========================

SaferMe API client for PHP

06.6kPHP

Since Oct 31Pushed 2y ago1 watchersCompare

[ Source](https://github.com/SmartOysters/saferme-api)[ Packagist](https://packagist.org/packages/smartoysters/saferme-api)[ RSS](/packages/smartoysters-saferme-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

SaferMe API PHP Package
=======================

[](#saferme-api-php-package)

[![Build Status](https://camo.githubusercontent.com/da97da457efbc9498f963a49fb05e3d2d80e6d05767ec925966849d89e92a86f/68747470733a2f2f6170702e7472617669732d63692e636f6d2f536d6172744f7973746572732f73616665726d652d6170692e7376673f6272616e63683d6d6173746572)](https://app.travis-ci.com/SmartOysters/saferme-api)

This package provides a complete **framework agnostic** SaferMe API client library for PHP.

Feel free to drop me a message at **** or tweet me at [@frodosghost](https://twitter.com/frodosghost).

Documentation
=============

[](#documentation)

Check out the [SaferMe Docs](https://github.com/SaferMe/saferme-api-docs).

Installation
============

[](#installation)

You can install the package via `composer require` command:

```
composer require smartoysters/saferme-api
```

Or simply add it to your composer.json dependences and run `composer update`:

```
"require": {
    "smartoysters/saferme-api": "^1.0"
}
```

Usage
=====

[](#usage)

Following details provided on the [authentication](https://saferme.github.io/saferme-api-docs/sessions.html) doc page.

`$installationId` is requested to be `something-unique-for-this-client-this-app-and-this-api-key`. We generated this value at [random.org](https://www.random.org/strings/?num=10&len=20&digits=on&upperalpha=on&loweralpha=on&unique=on&format=html&rnd=new), and select one of the generated keys, and use that in the integration. `$teamId` is set to extract information from an Organisation within SaferMe.

```
$email = 'xxxxxxxxxxxxxxxxxxxxxxxxxxx';
$password = 'xxxxxxxxxxxxxxxxxxxxxxxxxxx';
$appId = 'com.thundermaps.main';
$appBundleId = 'com.thundermaps.saferme';
$teamId = 1234;
$installationId = '';

$saferme = new SaferMe::OAuth([
    'email' => $email,
    'password' => $password,
    'appId' => $appId,
    'appBundleId' => $appBundleId,
    'installationId' => $installationId
]);
```

Teams
-----

[](#teams)

If you are using this Client to access multiple teams, you can configure to inject a single team in the Constructor, and reference another team in with `->team()` function before calling your endpoint.

```
// As above
$saferme = new SaferMe::OAuth([
    'email' => $email,
    'password' => $password,
    'appId' => $appId,
    'teamId' => $teamId,
    'appBundleId' => $appBundleId,
    'installationId' => $installationId
]);

$teamId = 4321;

$saferme->team($teamId)->channels()->list();
```

Guzzle Client Options
---------------------

[](#guzzle-client-options)

The options value in the constructor allows configuration for the [Guzzle Client](https://github.com/guzzle/guzzle/blob/master/src/Client.php#L27) to set any number of default request options.

```
$options = [
    'timeout'         => 0,
    'allow_redirects' => false,
    'proxy'           => '192.168.16.1:10'
];

$saferme = new SaferMe::OAuth([
    'email' => $email,
    'password' => $password,
    'appId' => $appId,
    'installationId' => $installationId,
    'options' => $options
]);
```

Inspiration
===========

[](#inspiration)

This package's inspiration is taken from the [Devio/Pipedrive](https://github.com/IsraelOrtuno/pipedrive) - it is such a nice code format for API interaction. Check him out on twitter :: [@IsraelOrtuno](https://twitter.com/IsraelOrtuno).

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity20

Early-stage or recently created project

 Bus Factor1

Top contributor holds 90.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/560bd90722157870b6a81651807fca5794a983cb52642922f8aaeb80b4146868?d=identicon)[frodosghost](/maintainers/frodosghost)

---

Top Contributors

[![frodosghost](https://avatars.githubusercontent.com/u/103463?v=4)](https://github.com/frodosghost "frodosghost (78 commits)")[![liamclaridge444](https://avatars.githubusercontent.com/u/72123211?v=4)](https://github.com/liamclaridge444 "liamclaridge444 (8 commits)")

---

Tags

phpsaferme-api

### Embed Badge

![Health badge](/badges/smartoysters-saferme-api/health.svg)

```
[![Health](https://phpackages.com/badges/smartoysters-saferme-api/health.svg)](https://phpackages.com/packages/smartoysters-saferme-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)