https://github.com/Le0X8/yourls-api-action-list

YOURLS plugin: how to implement a custom API action
https://github.com/Le0X8/yourls-api-action-list

Last synced: 14 days ago
JSON representation

YOURLS plugin: how to implement a custom API action

• Host: GitHub
• URL: https://github.com/Le0X8/yourls-api-action-list
• Owner: Le0X8
• Fork: true (rosano/yourls-api-action-list)
• Created: 2023-09-11T08:33:42.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-11T08:39:08.000Z (about 1 year ago)
• Last Synced: 2024-08-02T06:14:27.183Z (4 months ago)
• Language: PHP
• Homepage:
• Size: 3.91 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome - API List All + URLs - Add a "list" action to the API to show all keywords & URLs. This is a fork of the previous plugin and therefore incompatible with it. (Plugins / A)

README

        
# Plugin for YOURLS 1.6+: Custom API Action (list all keywords & URLs)

This plugin adds a custom API action at `list` to show all keywords used:

## Sample result

Using a URL such as `https://leox.li/yourls-api.php?signature=1002a612b4&action=list&format=json`:

```json

{

  "statusCode": 200,

  "message": "success",

  "result": [

    {

      "keyword": "website",

      "url": "https://leox.dev/"

    },

    {

      "keyword": "donald",

      "url": "https://donald.org/"

    },

    {

      "keyword": "gh",

      "url": "https://github.com/Le0X8/yourls-api-action-list"

    }

  ]

}

```

# Setup

1. Upload this folder to `/user/plugins`.

2. Activate this plugin from the Plugins administration page.