PHPackages                             numeno/api-admin - 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. [Authentication & Authorization](/categories/authentication)
4. /
5. numeno/api-admin

ActiveLibrary[Authentication & Authorization](/categories/authentication)

numeno/api-admin
================

\## Introduction Use the Numeno Administration API to create API Keys and set their permissions (which we call Scopes). This API is meant to be used by administrators of your organization. ## Scopes Scopes are used to let API Keys access only certain parts of the API. Scopes are expressed as a string of the form `api:resource:action`. For example, from the Numeno Article Recommender API (`art-rec`): - `art-rec:feeds:read` - can read any Feed (eg. `GET` `/feeds`, `/feeds/:id`, `/feeds/:id/streams`, etc.) - `art-rec:feeds:write` - can write (and read) any Feed - `art-rec:feeds:\*` - can perform any action on Feeds - `art-rec:\*:read` - can read any resource on `art-rec` - `\*:\*:\*` - can do everything

020PHP

Since Dec 17Pushed 1y agoCompare

[ Source](https://github.com/numenoai/apis-php-admin)[ Packagist](https://packagist.org/packages/numeno/api-admin)[ RSS](/packages/numeno-api-admin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

NumenoAPI-php
=============

[](#numenoapi-php)

Introduction
------------

[](#introduction)

Use the Numeno Administration API to create API Keys and set their permissions (which we call Scopes). This API is meant to be used by administrators of your organization.

Scopes
------

[](#scopes)

Scopes are used to let API Keys access only certain parts of the API.

Scopes are expressed as a string of the form `api:resource:action`.

For example, from the Numeno Article Recommender API (`art-rec`):

- `art-rec:feeds:read` - can read any Feed (eg. `GET` `/feeds`, `/feeds/:id`, `/feeds/:id/streams`, etc.)
- `art-rec:feeds:write` - can write (and read) any Feed
- `art-rec:feeds:*` - can perform any action on Feeds
- `art-rec:*:read` - can read any resource on `art-rec`
- `*:*:*` - can do everything

For more information, please visit .

Installation & Usage
------------------------

[](#installation--usage)

### Requirements

[](#requirements)

PHP 7.4 and later.

### Composer

[](#composer)

To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:

```
{
  "minimum-stability": "dev",
  "require": {
    "numeno/api-admin": "dev-main"
  }
}
```

Then run `composer install`

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```