Skip to main content

API документация

POST /v1/resources/transfer​

Tags: Resource

Summary: Передача ресурса пользователю от указанного пользователя

Тело запроса​

  • resourceKey: string, required
  • amount: number, required
  • receiverUserId: string, required
  • senderUserId: string, optional
  • comment: string, optional

Ответы​

  • 200: OK
    • transferInTransactionId: string (uuid), required
    • transferOutTransactionId: string (uuid), required
    • clientId: string (uuid), required
    • key: string, required
    • amount: number, required
    • fromUserId: string, required
    • toUserId: string, required
    • dateTime: string (date-time), required
    • comment: string, optional

GET /v1/resources/all/keys​

Tags: Resource

Summary: Получить список всех ресурсов в клиенте gmfy.

Ответы​

  • 200: OK
    • keys: array, required

POST /v1/payments​

Tags: Payment

Summary: Создание платежа.

Тело запроса​

  • amount: object, required
  • confirmation: object, required
  • userId: string, required
  • description: string, optional
  • locale: string, required

Ответы​

  • 200: OK
    • id: string (uuid), required
    • clientId: string (uuid), required
    • status: string, required
    • confirmationUrl: string, required

POST /v1/payments/{id}/noauth/resend-code​

Tags: Payment

Summary: Переотправка кода подтверждения платежа.

Параметры​

  • id (path, required): string [uuid]

Тело запроса​

Ответы​

  • 200: OK
    • id: string (uuid), required
    • clientId: string (uuid), required
    • value: number, required
    • returnUrl: string, required
    • description: string, optional
    • currency: string, required
    • status: string, required
    • locale: string, required
    • expiresIn: integer (int32), required

POST /v1/payments/{id}/noauth/confirm​

Tags: Payment

Summary: Подтверждение платежа без авторизации.

Параметры​

  • id (path, required): string [uuid]
  • requestForm (query, required): object

Ответы​

  • 200: OK

POST /v1/payments/{id}/noauth/cancel-payment​

Tags: Payment

Summary: Отмена платежа.

Параметры​

  • id (path, required): string [uuid]
  • requestForm (query, required): object

Ответы​

  • 200: OK

POST /v1/payments/{id}/confirm​

Tags: Payment

Summary: Подтверждение платежа.

Параметры​

  • id (path, required): string [uuid]

Ответы​

  • 200: OK
    • id: string (uuid), required
    • clientId: string (uuid), required
    • value: number, required
    • returnUrl: string, required
    • description: string, optional
    • currency: string, required
    • status: string, required
    • locale: string, required
    • expiresIn: integer (int32), required

GET /v1/payments/{id}​

Tags: Payment

Summary: Получение платежа по его id.

Параметры​

  • id (path, required): string [uuid]

Ответы​

  • 200: OK
    • id: string (uuid), required
    • clientId: string (uuid), required
    • value: number, required
    • returnUrl: string, required
    • description: string, optional
    • currency: string, required
    • status: string, required
    • locale: string, required
    • expiresIn: integer (int32), required

POST /v1/notifications/unread/mark-read​

Tags: Notification

Summary: Отмечает прочитанными непрочитанные уведомления

Параметры​

  • id (query, required): array

Ответы​

  • 200: OK

GET /v1/notifications​

Tags: Notification

Summary: Получение списка нотификаций для килента.

Ответы​

  • 200: OK

GET /v1/notifications/unread​

Tags: Notification

Summary: Получение списка непрочитанных нотификаций.

Параметры​

  • emitterType (query, optional): string enum: ['USER', 'RATING', 'BADGE', 'CHALLENGE', 'FEATURE', 'SERVICE', 'LEAGUE', 'TOURNAMENT', 'QUALIFIED_EVENT', 'RESOURCE']
  • markRead (query, optional): boolean

Ответы​

  • 200: OK

GET /v1/notifications/unread/{userId}​

Tags: Notification

Summary: Получение списка не прочитанных нотификаций для конкретного пользователя.

Параметры​

  • userId (path, required): string
  • emitterType (query, optional): string enum: ['USER', 'RATING', 'BADGE', 'CHALLENGE', 'FEATURE', 'SERVICE', 'LEAGUE', 'TOURNAMENT', 'QUALIFIED_EVENT', 'RESOURCE']
  • markRead (query, optional): boolean

Ответы​

  • 200: OK

POST /v1/events​

Tags: Event

Summary: Создание эвента.

Тело запроса​

  • userId: string, required
  • type: string, required
  • data: string, optional
  • zoneId: string, required
  • businessKey: string, optional
  • value: integer (int64), optional

Ответы​

  • 200: OK

POST /v1/events/batch​

Tags: Event

Summary: Создание пачки эвентов.

Тело запроса​

Ответы​

  • 200: OK

GET /v1/users​

Tags: User

Summary: Получение всей информации о пользователе по списку идентификаторов пользователей.

Параметры​

  • userId (query, optional): array

Ответы​

  • 200: OK

GET /v1/users/{userId}/ratings/{ratingId}​

Tags: User

Summary: Получение списка рейтингов пользователей.

Параметры​

  • userId (path, required): string
  • ratingId (path, required): string [uuid]
  • includeSubRatings (query, required): boolean

Ответы​

  • 200: OK
    • userId: string, required
    • clientId: string (uuid), required
    • ratingId: string (uuid), required
    • ratingName: string, optional
    • ratingValue: number, required
    • subRatings: array, optional

GET /v1/users/{userId}/nearest-badges​

Tags: User

Summary: Получить ближайшие бейджи для указанного пользователя

Параметры​

  • userId (path, required): string
  • limit (query, optional): integer [int32]

Ответы​

  • 200: OK

GET /v1/users/{userId}/badges​

Tags: User

Summary: Получить полученные пользовательские бейджи для указанного пользователя

Параметры​

  • userId (path, required): string
  • received (query, required): boolean

Ответы​

  • 200: OK

GET /v1/users/{id}​

Tags: User

Summary: Получить информацию по пользователю по его id.

Параметры​

  • id (path, required): string
  • userFilters (query, required): object

Ответы​

  • 200: OK
    • userId: string, required
    • clientId: string (uuid), required
    • userRatings: array, required
    • userChallenges: array, required
    • userBadges: array, required
    • userFeatures: array, required
    • userAccountBalances: array, required

GET /v1/users/{id}/resources/{resourceKey}/transactions​

Tags: User

Summary: Получение списка транзакций ресурса для пользователя по его id и id ресурса.

Параметры​

  • resourceKey (path, required): string
  • id (path, required): string
  • transactionTypes (query, optional): array
  • paginationParams (query, required): object

Ответы​

  • 200: OK

GET /v1/users/{id}/ratings/{ratingId}/by-group​

Tags: User

Summary: Получить рейтинг пользователя по указанному идентификатору рейтинга в указанных группах.

Параметры​

  • id (path, required): string
  • ratingId (path, required): string [uuid]
  • groupId (query, optional): array

Ответы​

  • 200: OK
    • userId: string, required
    • clientId: string (uuid), required
    • ratingId: string (uuid), required
    • ratingName: string, optional
    • ratingValue: number, required
    • groupRatings: array, required

GET /v1/user-groups/{id}/users/id​

Tags: Group

Summary: Получить id пользователей в группе.

Параметры​

  • id (path, required): string [uuid]

Ответы​

  • 200: OK

GET /v1/ratings/{id}​

Tags: Rating

Summary: Получить список юзер - рейтингов по списку id пользователей и id рейтинга.

Параметры​

  • id (path, required): string [uuid]
  • userId (query, optional): array

Ответы​

  • 200: OK

GET /v1/ratings/{id}/users/{userId}/positions​

Tags: Rating

Summary: Получить рейтинг пользователя по указанному идентификатору рейтинга и id пользователя

Параметры​

  • id (path, required): string [uuid]
  • userId (path, required): string

Ответы​

  • 200: OK
    • threeTopUsers: array, required
    • currentUser: object, required
    • neighborUsers: array, required

GET /v1/ratings/{id}/top​

Tags: Rating

Summary: Получение списка лучших пользователей в рейтинге по имени. По умолчанию отображается список из 10 лучших пользователей.

Параметры​

  • id (path, required): string [uuid]
  • paginationParams (query, required): object
  • sort (query, optional): string enum: ['ASC', 'DESC']

Ответы​

  • 200: OK

GET /v1/ratings/{id}/groups/{groupId}/users​

Tags: Rating

Summary: Получение рейтинга пользователей по указанному идентификатору рейтинга в указанных группах.

Параметры​

  • id (path, required): string [uuid]
  • groupId (path, required): string [uuid]
  • paginationParams (query, required): object

Ответы​

  • 200: OK

GET /v1/ratings/all​

Tags: Rating

Summary: Получение списка всех рейтингов

Ответы​

  • 200: OK

GET /v1/challenges/{id}/top​

Tags: Challenge

Summary: Получение списка лучших пользователей в челленджа по его id. По умолчанию выбирается список из 10 лучших пользователей.

Параметры​

  • id (path, required): string [uuid]
  • limit (query, optional): integer [int32]

Ответы​

  • 200: OK

GET /v1/challenges/all​

Tags: Challenge

Summary: Получение списка челленджей для клиента.

Ответы​

  • 200: OK

GET /v1/badges/{userId}​

Tags: Badge

Summary: Получение списка бейджей для юзера.

Параметры​

  • userId (path, required): string [uuid]

Ответы​

  • 200: OK

GET /v1/badges/users​

Tags: Badge

Summary: Получение списка бейджей по выбранным id пользователей

Параметры​

  • userId (query, required): array
  • limit (query, optional): integer [int32]

Ответы​

  • 200: OK

GET /v1/badges/light​

Tags: Badge

Summary: Получить бейджи без учета указанных id

Параметры​

  • excludedId (query, optional): array
  • paginationParams (query, required): object

Ответы​

  • 200: OK