S

    Profiles

    A profile is the equivalent of a phone in a game. This profile is linked to an in-game telephone number, so a profile is not necessarily linked to a player. If your in-game phone is linked to a specific player (can't be shared across inventories...) then you can assume that one iPear profile is linked to one player.

    You can handle profiles as you want, as long as custom_id and phone_number are unique (individually, it's not a unique-couple).

    Examples:

    • My in-game phone is an item that can be shared between players via inventories, and a player can have several phones.

    In this case, to create a profile, the custom_id will be the id of the item in your database, and the phone_number will be the phone number associated with the item.

    • The phone is associated with the character the player is playing. A player can have several characters, but the phone cannot be shared with other players.

    Here, the custom_id will be the character id, and the phone_number will be the number associated with this character.

    • The player only has one character on our server, it can only have one phone and cannot be shared.

    You can enter the SteamID for the custom_id, and associate its phone number for the phone_number.

    Important

    You cannot update data of a profile at this moment.

    Some profiles action are managed by the websocket.

    Reference

    KeyTypeDescription
    custom_idstring
    unique
    		Unique identifier from your services (1-64 characters)
    namestringRolePlay name of the profile (1-64 characters)
    phone_numberstring
    unique
    		Phone number of the profile (1-64 characters)

    Incoming events

    Outgoing events

    On this page

    Powered by Doctave