1. Forum
  2. fsxNet
  3. FSX BBS

  • HTTP API available on clrghouz

    From deon@21:2/116 to All on Sun Aug 24 14:46:23 2025
    Howdy,

    I've had a bit of renewed energy to work on clrghouz of late (I was working on something else for the last few months), so I've implemented at HTTP API.

    The only thing that I've set up at the moment is netmail, so you can HTTP "post" to send a netmail, and HTTP "get" to get the netmail that is in the queue to be sent to you (in packet form).

    If anybody wants to play with it, let me know. Hub 3 users are pretty much ready to use it - you just need to create a HTTP API token (Bearer token) and then start sending your HTTP requests.

    Non Hub 3 users will need to login to clrghouz, claim your BBS and then you'll be set to go.

    I'll add a swagger interface to clrghouz, so you'll be able to see what endpoints are available and how to use them.

    Yell out if you have questions.


    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)
  • From slacker@21:3/193 to deon on Sun Aug 24 06:48:44 2025
    Nice!! I'd be interested to give it a try!

    Is there a new section on the page for the API and create the bearer token? I just checked and can't seem to find it.

    Thanks!


    --- NE BBS v1.11.1 (linux; x64)
    * Origin: NE BBS - nebbs.servehttp.com:9223 (21:3/193)
  • From deon@21:2/116 to slacker on Mon Aug 25 08:00:13 2025
    Re: Re: HTTP API available on clrghouz
    By: slacker to deon on Sun Aug 24 2025 06:48 am

    Hey Slacker,

    Nice!! I'd be interested to give it a try!

    Is there a new section on the page for the API and create the bearer token? I just checked and can't seem to find it.

    The Bearer token is actually associated with your BBS (aka "System" in clrghouz speak), you should see it when you click on your BBS.

    I need to put up a swagger UI that gives you the documentation that you need, but once you have your token you can hit:

    GET: /api/whoami
    GET/POST: /api/mail/new

    When posting a message you need "to", "from", "subject", "date" and a base64encoded "body". Date needs to be in ISO 8601 format, eg:
    2025-08-21T10:15:19.000000+10:00

    If your post is successful, you should get a 200 with a msgid returned, otherwise an error message, explaining why.

    I havent integrated the posting into clrghouz's response engine, so sending a message to clrghouz (eg: ping/areafix) wont respond - but I'll add that in due course.

    Let me know if you have stuck or something doesnt work as expected.


    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)
  • From paulie420@21:2/150 to deon on Mon Aug 25 18:47:12 2025
    I've had a bit of renewed energy to work on clrghouz of late (I was working on something else for the last few months), so I've implemented
    at HTTP API.

    Would you mind posting a summary of what clrghouz is - FTNs are my BBS weak point, but I'm interested in projects that support our community.



    |07p|15AULIE|1142|07o
    |08.........

    --- Mystic BBS v1.12 A49 2024/05/29 (Linux/64)
    * Origin: 2o fOr beeRS bbs>>>20ForBeers.com:1337 (21:2/150)
  • From deon@21:2/116 to paulie420 on Tue Aug 26 12:33:22 2025
    Re: Re: HTTP API available on clrghouz
    By: paulie420 to deon on Mon Aug 25 2025 06:47 pm

    Hey Paulie,

    Would you mind posting a summary of what clrghouz is - FTNs are my BBS weak point, but I'm interested in projects that support our community.

    I have a description on it's home page:

    https://clrghouz.bbs.dege.au/about


    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)
  • From deon@21:2/116 to slacker on Wed Aug 27 08:15:21 2025
    Re: Re: HTTP API available on clrghouz
    By: deon to slacker on Mon Aug 25 2025 08:00 am

    Hey slacker,

    I need to put up a swagger UI that gives you the documentation that you need, but once you have your token you can hit:

    The API documentation should slowly reveal it self here:

    https://clrghouz.bbs.dege.au/docs/api


    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)
  • From slacker@21:3/193 to deon on Wed Aug 27 15:35:27 2025
    The API documentation should
    slowly reveal it self here:

    https://clrghouz.bbs.dege.au/docs/

    Awesome!! Thanks!
    Just ran some test requests and they worked!


    --- NE BBS v1.11.1 (linux; x64)
    * Origin: NE BBS - nebbs.servehttp.com:9223 (21:3/193)
  • From deon@21:2/116 to paulie420 on Thu Aug 28 11:55:46 2025
    Re: Re: HTTP API available on clrghouz
    By: deon to paulie420 on Tue Aug 26 2025 12:33 pm

    Howdy,

    I have a description on it's home page:

    https://clrghouz.bbs.dege.au/about

    Did it make sense?


    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)
  • From paulie420@21:2/150 to deon on Thu Aug 28 23:05:41 2025
    I have a description on it's home page:

    https://clrghouz.bbs.dege.au/about

    Did it make sense?

    Perfect. :P Thanks for the share; I've also archived clrghouz.bbs.dege.au @ archivebox.20ForBeers.com.



    |07p|15AULIE|1142|07o
    |08.........

    --- Mystic BBS v1.12 A49 2024/05/29 (Linux/64)
    * Origin: 2o fOr beeRS bbs>>>20ForBeers.com:1337 (21:2/150)
  • From RetroSwim@21:2/150 to paulie420 on Sun Aug 31 05:05:44 2025
    Would you mind posting a summary of what clrghouz is - FTNs are my BBS weak point, but I'm interested in projects that support our community.

    It's cool as hell!! One cool feature is, since my board doesn't support using QWK mail for anything besides offline readers, I can poll DOVENet like a normal Fido style net, and clrghouz handles the conversion.

    I'm not even using a fraction of its power, either!!

    --- Mystic BBS v1.12 A49 2024/05/29 (Linux/64)
    * Origin: 2o fOr beeRS bbs>>>20ForBeers.com:1337 (21:2/150)
  • From slacker@21:3/193 to deon on Sun Sep 14 02:13:46 2025
    Hi Deon,
    I was just curious if the API is going to be a permanent addition to clrghouz? I was thinking of reworking the code of my tosser to route netmails through it and only use binkd if for some reason the API call failed.

    Thanks!


    --- NE BBS v1.11.1 (linux; x64)
    * Origin: NE BBS - nebbs.servehttp.com:9223 (21:3/193)
  • From deon@21:2/116 to slacker on Sun Sep 14 12:31:35 2025
    Re: Re: HTTP API available on clrghouz
    By: slacker to deon on Sun Sep 14 2025 02:13 am

    Howdy,

    I was just curious if the API is going to be a permanent addition to clrghouz? I was thinking of reworking the code of my tosser to route netmails through it and only use binkd if for some reason the API call failed.

    It is - I'll also add an API to post echomail, as well as one to download/upload a mail packet (so you dont need a mailer).

    (I'm distracted on fixing my binkd implementation at the moment, so when that's done, I'll work more on API stuff).

    Have you been using the netmail API? I've only implemented basic functionality, so want to be sure its robust before spending more time on other things (like responding to PING/AREAFIX, etc).

    I'm also playing with rabbitmq (for no other reason other than I'm curios), and I'm goign to implement a rabbitmq<->rabbitmq link for other clrghouz hub to hub instances (well see if it is something that could work).

    Was wondering if that might be good for a BBS, I think I saw javascript MQ clients so not sure how easy that might be to integrate with SBBS for example. For other mailers, a simple PHP script could pull mail out of the queue.

    If only there were 48hrs in day... :)




    ...лоеп
    --- SBBSecho 3.27-Linux
    * Origin: I'm playing with ANSI+videotex - wanna play too? (21:2/116)