Swagger UI

RealMQ client api
 0.3.0 

[ Base URL: api.realmq.com/client/v1 ]
https://api.realmq.com/client/v1/openapi.json

Getting Started

  • Get in touch with us to get an account set up. You can do that by sending an email to service@realmq.com
  • We'll provide you with an accessToken with admin scope that allows you to create further users and access tokens.
  • Paste the accessToken into the access token input field in the header of the api browser.
  • There are two access groups (scopes). Every API endpoint has a description of what scopes are allowed to perform requests.
    • admin Full management capabilities, administration capabilities
    • user Restricted access

API Resources

  • Users: A user may be a human, a bot, a sensor, a server etc. and is able to participate in channel communications.
  • Channels: A channel is a message gateway and broadcasts a message, data, event etc. to all its users.
  • Subscriptions: A subscription describes the access rights of users on channels.
  • Auth Tokens: A token is issued for one user and grants scope specific Rest- & Realtime API access rights.

Custom Ids

  • In order to provide optimal integratability, you can work with custom ids on channels, users, subscriptions and auth-tokens.
  • When creating these resources, you can pass an id property to the payload.
  • You can then reference the resource by its custom id: eg. GET /users/test-bot-1.
  • Valid ids must match ^[\w-]+$ (alpha-numeric, -, _).
  • If you do not provide a custom id, a UUIDv4 will be generated by default.

Error Responses

Status CodeError CodeError Message
400 - Bad RequestInvalidRequestSchemaRequest validation failed: Parameter (offset) is not a valid integer: INVALID_INPUT.
AlreadySubscribedThe subscription could not be created, since the given user is already subscribed to the channel.
AuthTokenAlreadyExistsThe auth token could not be created, since a token with the same id already exists.
ChannelAlreadyExistsThe channel could not be created, since a channel with the same id already exists..
InvalidAuthTokenPatch cannot be applied, since the resulting auth token won't be valid.
InvalidChannelPatch cannot be applied, since the resulting channel won't be valid.
InvalidPatchThe given payload is no valid JSON-Patch document.
InvalidSubscriptionPatch cannot be applied, since the resulting subscription won't be valid.
InvalidUserPatch cannot be applied, since the resulting user won't be valid.
SubscriptionAlreadyExistsThe subscription could not be created, since a subscription with the same id already exists.
UserAlreadyExistsThe user could not be created, since a user with the same id already exists.
401 - UnauthorizedInvalidAuthorizationMissing or invalid authorization header.
403 - ForbiddenInsufficientPrivilegesInsufficient rights to access or manipulate the requested resource.
404 - Not FoundEndpointNotFoundThe requested API endpoint does not exist.
UnknownAuthTokenThe requested auth token does not exist.
UnknownChannelThe requested channel does not exist.
UnknownSubscriptionThe requested subscription does not exist.
UnknownUserThe requested user does not exist.
500 - Internal Server ErrorInternalServerErrorYour request could not be processed.

Auth

Manage authorization and authentication.

Channels

Manage channels.

Info

Information about the API.

Me

Manage resources represented by the authenticated client.

Subscriptions

Manage user access on channels.

Users

Manage users.

Online validator badge