API Endpoints

Stapsher API Endpoints

BaseUrl

The Public API is hosted at: https://stapsher.extrastatic.xyz

Version 1 latest

https://stapsher.extrastatic.xyz/v1

Latest Version:

If version is omitted, latest version will be used:

https://stapsher.extrastatic.xyz

/encrypt/{string}

Method: GET

Parameters:

  • {string}: Text to encrypt

Description: Returns the Encrypted {string}

Additonal Information:

EncryptedString

/github/webhook

Method: POST

Description: Receives Webhooks for various GitHub App Events

Additonal Information:

GitHub Webhooks

/{platform}/{username}/{repository}/{branch}/{entryType}/new

Method: POST

Parameters:

  • {branch}: Repository Branch
  • {entryType}: Type of entry
  • {platform}: Git Platform (github / gitlab)
  • {repository}: Repository’s name
  • {username}: Username

Body:

  • fields: Object (containing the main data)
  • options: Object (containing additional data)

Additonal Information:

Usage with HTML Forms

/{platform}/{username}/{repository}/{branch}/{entryType}/verify/akismet

Method: GET

Parameters:

  • {branch}: Repository Branch
  • {entryType}: Type of entry
  • {platform}: Git Platform (github / gitlab)
  • {repository}: Repository’s name
  • {username}: Username

Description: Checks if the akismet configuration in stapsher.yaml is valid.