Compte

Compte, magasins, permissions et quotas de la clé utilisée

GET /v1/me
vpn_key Toute clé valide Compte comme une lecture

Premier appel à faire. Indique à quel compte la clé est rattachée, la liste de ses magasins (leurs identifiants servent dans les autres appels), les permissions de la clé, l'état des quotas et les plafonds à respecter.

Aucune permission particulière n'est requise : toute clé valide peut appeler cette adresse. L'appel compte dans le quota de lecture.

Exemple d'appel

curl "https://api.wanapos.com/v1/me" \
  -H "Authorization: Bearer VOTRE_CLE"

Réponse en cas de succès (statut 200)

Informations du compte et de la clé.

Champ Type Description
meta objet
meta.request_id texte Identifiant de l'appel, à communiquer à l'assistance en cas de problème.
data objet
data.account objet Le compte Wanapos auquel la clé est rattachée.
data.account.id entier Identifiant du compte.
data.account.name texte Nom du compte, tel que le commerçant l'a saisi.
data.account.currency texte Devise du compte, code ISO 4217 (exemple : EUR).
data.account.timezone texte Fuseau horaire utilisé pour les dates et pour la remise à zéro des quotas.
data.shops liste Magasins du compte, hors magasins archivés.
data.shops[].id entier Identifiant du magasin, à utiliser dans les autres appels.
data.shops[].name texte Nom du magasin.
data.shops[].active booléen Le magasin est actif.
data.api_key objet La clé utilisée pour cet appel.
data.api_key.name texte Nom donné à la clé par le titulaire du compte.
data.api_key.hint texte Début et fin de la clé, pour la reconnaître. Ne permet pas de la reconstituer.
data.api_key.scopes liste de texte Permissions portées par la clé.
data.api_key.created_at texte Date de création de la clé (ISO 8601).
data.quotas objet État des quotas du compte, cet appel compris.
data.quotas.per_minute objet État d'un quota.
data.quotas.per_minute.limit entier Nombre d'appels autorisés sur la période.
data.quotas.per_minute.remaining entier Nombre d'appels encore disponibles sur la période en cours.
data.quotas.per_minute.reset_at texte Date et heure de remise à zéro du compteur (ISO 8601).
data.quotas.reads_per_day objet État d'un quota.
data.quotas.reads_per_day.limit entier Nombre d'appels autorisés sur la période.
data.quotas.reads_per_day.remaining entier Nombre d'appels encore disponibles sur la période en cours.
data.quotas.reads_per_day.reset_at texte Date et heure de remise à zéro du compteur (ISO 8601).
data.quotas.writes_per_day objet État d'un quota.
data.quotas.writes_per_day.limit entier Nombre d'appels autorisés sur la période.
data.quotas.writes_per_day.remaining entier Nombre d'appels encore disponibles sur la période en cours.
data.quotas.writes_per_day.reset_at texte Date et heure de remise à zéro du compteur (ISO 8601).
data.limits objet Plafonds à respecter dans les appels.
data.limits.max_page_size entier Nombre maximal de résultats par page (paramètre limit).
data.limits.default_page_size entier Nombre de résultats par page si limit n'est pas précisé.
data.limits.max_items_per_write entier Nombre maximal d'éléments dans un appel de création.
data.limits.max_body_bytes entier Taille maximale du contenu envoyé, en octets.
data.api objet
data.api.version texte Version de l'API.
data.api.documentation_url texte Adresse de la documentation.
{
    "data": {
        "account": {
            "id": 1451,
            "name": "Ma boutique",
            "currency": "EUR",
            "timezone": "Europe/Paris"
        },
        "shops": [
            {
                "id": 1,
                "name": "Magasin principal",
                "active": true
            }
        ],
        "api_key": {
            "name": "Mon assistant IA",
            "hint": "wps_Ab3d…x9Kq",
            "scopes": [
                "read_customers"
            ],
            "created_at": "2026-11-10T14:30:00+01:00"
        },
        "quotas": {
            "per_minute": {
                "limit": 60,
                "remaining": 59,
                "reset_at": "2026-11-10T14:31:00+01:00"
            },
            "reads_per_day": {
                "limit": 5000,
                "remaining": 4999,
                "reset_at": "2026-11-11T00:00:00+01:00"
            },
            "writes_per_day": {
                "limit": 1000,
                "remaining": 1000,
                "reset_at": "2026-11-11T00:00:00+01:00"
            }
        },
        "limits": {
            "max_page_size": 100,
            "default_page_size": 50,
            "max_items_per_write": 50,
            "max_body_bytes": 1048576
        },
        "api": {
            "version": "v1",
            "documentation_url": "https://wanapos.com/api"
        }
    },
    "meta": {
        "request_id": "3f9a1c0b7d2e4a61"
    }
}

Erreurs possibles

  • 401 Clé absente, inconnue ou révoquée. Codes : missing_key, invalid_key.
  • 403 Appel refusé pour ce compte ou cette clé. Codes : api_not_activated, account_not_eligible, access_blocked, missing_scope.
  • 429 Quota dépassé. Codes : rate_limited, daily_quota_exceeded, too_many_failed_attempts. L'en-tête Retry-After indique combien de secondes attendre.

Voir toutes les erreurs

Une question ? contact@wanapos.com