Get started

Overview OAuth 2.0 Websocket API

Accounts

GET /get_me GET /tokens POST /login DELETE /logout POST /register POST /confirm POST /reset POST /reset_password GET /incoming_requests GET /outcoming_requests

Apps

GET /apps POST /apps GET /apps/{public_key} GET /apps/{public_key}/token POST /apps/{public_key}/token GET /apps/tokens DELETE /apps/tokens/{token} DELETE /apps/{app_id} GET /apps/user/{token}

Users

GET /user/{user_tag} GET /user/{user_tag}/friends GET /user/{user_tag}/playlists GET /user/{user_tag}/photos GET /user/{user_tag}/posts POST /user/{user_tag}/post

Relationships

GET /user/{user_tag}/relationships PATCH /user/{user_tag}/subscribe DELETE /incoming_requests/{user_id}

Dialogs (Messages)

GET /dialogs POST /dialogs POST /dialogs/private/{user_id} GET /dialogs/{dialog_id} GET /dialogs/{dialog_id}/messages GET /dialogs/messages/{message_id} DELETE /dialogs/messages/
{message_id} PATCH /dialogs/{dialog_id}/mute

Tracks (MuseBase)

GET /musebase/{track_id} GET /musebase/find/{mask} POST /musebase/upload GET /musebase/playlists/{playlist_id} GET /user/{user_tag}/playlists

Photos

GET /photos/{photo_id} POST /photos/upload DELETE /photos/{photo_id} GET /user/{user_tag}/photos

Posts

GET /posts/{post_id} DELETE /posts/{post_id} PATCH /posts/{post_id} PATCH /posts/{post_id}/like GET /posts/{post_id}/comments POST /posts/{post_id}/comment

Comments

GET /comments/{comment_id} DELETE /comments/{comment_id} PATCH /comments/{comment_id}/like

Safety

GET /safety/link

Other

GET /languages GET /countries GET /countries/{country_id}/regions GET /countries/{country_id}/regions/
{region_id}/cities

Yurba CDN (cdn.yurba.one)

GET /photos/{photo_id}.jpg GET /musebase/{track_id}.mp3

Yurba Desktop API

START Get started METHOD createSystemNotification METHOD reload METHOD quit METHOD openUrl METHOD createWindow METHOD createButton METHOD button OBJECT Tab OBJECT Player OBJECT User OBJECT window

Yurba Component Language

Websocket API

Yurba uses a secure websocket (wss) to receive messages/alerts and other events.

GET wss://api.yurba.one/ws

Query string:

token: string

Authorization

To receive websocket messages, you must connect to it using a user token. All messages come in the form of an EventModel. Some events are not global. They can be obtained by subscribing to a specific category.

{
   Type: string,
   Message: model
}

A message is any model from the API, depending on the type.

Event types

Global

notification: NotificationModel (new notification)
message: MessageModel (on new message)
message_delete: MessageModel (on message delete)

Subscription

online: OnlineModel (on user went online)
typing: TypingModel
read: ReadModel

Subscription

To subscribe to the event category you should send the following json to the websocket, having connected in advance.

{
   command: 'subscribe',
   category: string,
   thing_id: int
}

Dialog

{
   command: 'subscribe',
   category: 'dialog',
   thing_id: int # dialog ID
}

TypingModel

Sent when someone writes a message in a dialog. Only those who subscribe to the dialog receive.

{
   Dialog: int,
   User: ShortUserModel
}

More about ShortUserModel you can look here: /user/{user_id}

ReadModel

Sent when someone has read the dialog. Only those who subscribe to the dialog receive.

{
   Dialog: int
}