PSI Server

A backend service for Yellow Cowries application features and APIs.

Status: running.

API base path: /api.

Yellow Cowries Plan Save Invest API 1.0.0

This API provides a socket.io interface for the Plan Save Invest game by Yellow Cowries.

Game Modes:

  • Multiplayer
  • Singleplayer (with bots)
  • Private (invite-only)

Gameplay features:

  • Card Trading
  • Word Scoring
  • Financial Education
  • Question & Answer

Servers

  • https://staging.psi.cowrywise.com/httpsstaging

    PSI Game Server

    • #env:staging
    • #kind:remote
    • #visibility:private

Operations

  • RECEIVE game

    Operation IDGameStateChanged

    Available only on servers:

    Accepts the following message:

    Game state changedGameStateChanged

    Inform about any updates to the game state.

    Message IDGameStateChanged
    object

    Examples

  • SEND game

    Play Multiplayer

    Operation IDPlayMultiplayer

    Available only on servers:

    Accepts the following message:

    Play MultiplayerPlayMultiplayer

    Play against other random players.

    Message IDPlayMultiplayer

    Examples

  • SEND game

    Play Bot

    Operation IDPlayBot

    Available only on servers:

    Accepts the following message:

    Play BotPlayBot

    Play against a bot.

    Message IDPlayBot

    Examples

  • SEND game

    Play against friends with a shared code.

    Operation IDPlayPrivate

    Available only on servers:

    Accepts the following message:

    Play PrivatePlayPrivate

    Play against friends.

    Message IDPlayPrivate
    object

    Examples

  • SEND game

    Start a pending Game.

    Operation IDStartGame

    Available only on servers:

    Accepts the following message:

    Start GameStartGame

    Start the current game.

    Message IDStartGame

    Examples

  • SEND game

    Leave the current game.

    Operation IDLeaveGame

    Available only on servers:

    Accepts the following message:

    Leave GameLeaveGame

    Leave the current game.

    Message IDLeaveGame

    Examples

  • SEND game

    Swap a card from the deck.

    Operation IDDrawCard

    Available only on servers:

    Accepts the following message:

    Draw CardDrawCard

    Draw a card from the deck.

    Message IDDrawCard
    object

    Examples

  • SEND game

    Make a word with the cards in your hand.

    Operation IDMakeWord

    Available only on servers:

    Accepts the following message:

    Make WordMakeWord

    Make a word with the cards in your hand.

    Message IDMakeWord
    object

    Examples

  • SEND game

    Initiate a trade with another player.

    Operation IDInitiateTrade

    Available only on servers:

    Accepts the following message:

    Initiate TradeInitiateTrade

    Initiate a trade with another player.

    Message IDInitiateTrade
    object

    Examples

  • SEND game

    Accept a trade with another player.

    Operation IDAcceptTrade

    Available only on servers:

    Accepts the following message:

    Accept TradeAcceptTrade

    Accept a trade with another player.

    Message IDAcceptTrade
    object

    Examples

  • SEND game

    Reject a trade with another player.

    Operation IDRejectTrade

    Available only on servers:

    Accepts the following message:

    Reject TradeRejectTrade

    Reject a trade with another player.

    Message IDRejectTrade

    Examples

  • SEND game

    Complete a trade with another player.

    Operation IDCompleteTrade

    Available only on servers:

    Accepts the following message:

    Complete TradeCompleteTrade

    Complete a trade with another player.

    Message IDCompleteTrade
    object

    Examples

  • SEND game

    Cancel a trade with another player.

    Operation IDCancelTrade

    Available only on servers:

    Accepts the following message:

    Cancel TradeCancelTrade

    Cancel a trade with another player.

    Message IDCancelTrade

    Examples

Messages

  • #1Game state changedGameStateChanged

    Inform about any updates to the game state.

    Message IDGameStateChanged
    object
  • #2Play MultiplayerPlayMultiplayer

    Play against other random players.

    Message IDPlayMultiplayer
  • #3Play BotPlayBot

    Play against a bot.

    Message IDPlayBot
  • #4Play PrivatePlayPrivate

    Play against friends.

    Message IDPlayPrivate
    object
  • #5Start GameStartGame

    Start the current game.

    Message IDStartGame
  • #6Leave GameLeaveGame

    Leave the current game.

    Message IDLeaveGame
  • #7Draw CardDrawCard

    Draw a card from the deck.

    Message IDDrawCard
    object
  • #8Make WordMakeWord

    Make a word with the cards in your hand.

    Message IDMakeWord
    object
  • #9Initiate TradeInitiateTrade

    Initiate a trade with another player.

    Message IDInitiateTrade
    object
  • #10Accept TradeAcceptTrade

    Accept a trade with another player.

    Message IDAcceptTrade
    object
  • #11Reject TradeRejectTrade

    Reject a trade with another player.

    Message IDRejectTrade
  • #12Complete TradeCompleteTrade

    Complete a trade with another player.

    Message IDCompleteTrade
    object
  • #13Cancel TradeCancelTrade

    Cancel a trade with another player.

    Message IDCancelTrade

Schemas

  • object
  • object [Player]

    A player in the game.

  • object [Trade]

    A trade in the game.

  • object [Offer]

    An offer to trade a card.

  • object
  • object
  • object
  • object
  • object
  • object