$myAppliz->users(string $action, array $fields, array $users_ids, ?array $options): array|object

Cette méthode retourne les données des utilisateurs users_ids.

$myAppliz->users(string $action, array $key_val, string|array $users_ids): bool

Avec le paramètre store cette méthode permet de sauvegarder des informations sur les utilisateurs users_ids.
Elle retourne true en cas de succès et false en cas d'erreur.

ParamètresDescription
action
string
 Les actions disponibles.
get
 Pour obtenir des informations sur les utilisateurs.
store
 Pour sauvegarder des informations sur les utilisateurs.
fields
array
 Liste des données à retourner.
users_ids
string|array
 Les identifiants ou le wildcard * pour retourner l'ensemble des utilisateurs de votre Appliz (500 max).
keys_vals
array
 Un tableau de données d'utilisateur personnalisées à ajouter, remplacer ou supprimer.
{$champ_personnalisé}
 Valeur personnalisée à créer ou remplacer (maximum 9 000 caractères).
{$champ_personnalisé}.{$var}
 Créer ou remplace la valeur {$var} sans remplacer intégralement {$champ_personnalisé}.
$unset
 {$champ_personnalisé} ou {$champ_personnalisé}.{$var} ou tableau de champs personnalisés à supprimer.
options
array
 Options (facultatif).
FieldsDescription
id
string
 L'identifiant de l'utilisateur. Cet identifiant est unique par Appliz et ne peut pas être utilisé par une autre.
first_name
string
 Le prénom de l'utilisateur.
last_name
string
 Le nom de famille de l'utilisateur.
gender
string
 Le genre de l'utilisateur.
male
 Homme
female
 Femme
perms
array|object
 Liste des permissions accordées par l'utilisateur.
send_sms
 L'utilisateur autorise votre Appliz à lui envoyer des sms.
send_mail
 L'utilisateur autorise votre Appliz à lui envoyer des mails.
birthday
array|object
 La date de naissance et l'age de l'utilisateur.
datetime
string
 La date de naissance de l'utilisateur selon datetime_format.
age
int
 L'age de l'utilisateur.
register_time
array|object
 La date d'inscription.
appliz['datetime']
string
 La date d'inscription à votre Appliz selon datetime_format.
myAppliz['datetime']
string
 La date d'inscription à myAppliz selon datetime_format.
user
string
 L'identifiant myAppliz de l'utilisateur (qui n'est pas unique par Appliz).
Permet par exemple de repérer un utilisateur qui s'est désinscrit puis ré-inscrit à votre Appliz.
perso_{$var}
string|int|float|array|object|bool
 Un champ personnalisé définit via le paramètre store.
uninstall_time
array|object
 Champ présent si l'utilisateur s'est désinscrit de votre appliz.
datetime
string
 La date de désinscription de l'utilisateur à votre Appliz selon datetime_format.
me
bool
 Champ présent uniquement si l'utilisateur actuellement connecté est celui-ci.
OptionsDescription
datetime_format
string
 Format des dates. Cette option est prioritaire sur le paramètre général de la configuration.

Valeur par défaut : c
sort
int
 Pour trier les résultats du plus anciens au plus récent ou inversement.
1
 Du plus ancien au plus récent (valeur par défaut).
-1
 Du plus récent au plus ancien.
include_uninstall
bool
 Pour inclure ou non les utilisateurs ayant désinstallés votre Appliz. ATTENTION : Si vous demandez le champ uninstall_time l'option include_uninstall vaudra true.
true
 Inclus les utilisateurs ayant désinstallé votre Appliz dans les résultats.
false
 Exclu les utilisateurs ayant désinstallé votre Appliz dans les résultats (valeur par défaut sauf si $fields contient uninstall_time).
limit
int
 Nombre de résultats par requête (500 max).

Valeur par défaut : 100
next
string
 Identifiant à renseigner pour obtenir les résultats suivants.
ids_in_keys
bool
 Pour utiliser ou non les identifiants utilisateurs comme clés dans les résultats. Cette option est prioritaire sur le paramètre général de la configuration.
true
 Utiliser les identifiants des utilisateurs ent tant que clés (valeur par défaut).
false
 Ne pas utiliser les identifiants des utilisateurs ent tant que clés.

Exemple

try

{

    $users = $myAppliz->users(

    'get',

    ['id', 'prenom', 'nom', 'genre'],

    ['59e9098ad544cc6a63257c92', 'me', '59f76da2d544cc1463524122'],

    ['limit' => 2]

    );

}

catch(Exception $e)

{

    error_log('Erreur API myAppliz : '.$e->getMessage());

    echo 'Une erreur s\'est produite, veuillez réessayer ultérieurement.';

    exit();

}



echo '2 premiers résultats :';

echo '<pre>'. htmlspecialchars(print_r($users, true)) .'</pre>';



if(isset($users['paging']['next'])) // Pour vérifier si il y a d'autres résultats

{

    try

    {

        $users = $myAppliz->users(

        'get',

        ['id', 'prenom', 'nom', 'genre'],

        ['59e9098ad544cc6a63257c92', 'me', '59f76da2d544cc1463524122'],

        ['next' => $users['paging']['next'], 'limit' => 1] // Pour obtenir les résultats suivants, vous pouvez modifier l'option « limit » à tout moment

        );

    }

    catch(Exception $e)

    {

        error_log('Erreur API myAppliz : '.$e->getMessage());

        echo 'Une erreur s\'est produite, veuillez réessayer ultérieurement.';

        exit();

    }



    echo '3ème résultat&nbsp;:';

    echo '<pre>'. htmlspecialchars(print_r($users, true)) .'</pre>';

}

Résultat :

2 premiers résultats :
Array
(
    [59e9098ad544cc6a63257c92] => Array
        (
            [id] => 59e9098ad544cc6a63257c92
            [prenom] => joe
            [nom] => lyubarskiysky
            [genre] => femme
        )

    [59f76da2d544cc1463524122] => Array
        (
            [id] => 59f76da2d544cc1463524122
            [prenom] => marine
            [nom] => trottier
            [genre] => homme
        )

    [paging] => Array
        (
            [next] => 61d059b54b94c352101f04f2
        )

)
3ème résultat :
Array
(
    [me] => Array
        (
            [id] => 5f54a4eef845d309f1048384
            [prenom] => alexis
            [nom] => bonnyaud
            [genre] => homme
            [me] => 1
        )

)