Passer au contenu principal

Comment lire un code d’assistance Quavern

PPPPX-YYYY, le sens des quatre lettres et du chiffre de classe, et ce qu’il faut envoyer à l’assistance.

J
Écrit par Jean-Baptiste COULON--CHABAGNO

Lorsqu’une opération échoue, Quavern affiche un code d’assistance tel que APIE1-0429. Ce n’est pas un numéro de référence tiré au hasard : chacune de ses parties a un sens, et il ne change jamais de sens une fois publié. Le citer, c’est indiquer à l’assistance la condition exacte que vous avez rencontrée, sans série de questions.

La forme

PPPPX-YYYY

  • PPPP — quatre lettres majuscules. La partie de Quavern à laquelle la panne appartient.

  • X — un chiffre. La classe : la nature de ce qui s’est produit, et donc qui peut y remédier.

  • YYYY — quatre chiffres. Un identifiant stable. 0ZZZ reprend un statut HTTP générique. De 1000 à 9999, il identifie une condition précise et rien d’autre.

Le véritable statut HTTP reste toujours dans la réponse elle-même. Pour les codes numérotés à partir de 1000, les quatre chiffres forment un identifiant : n’essayez pas d’en déduire un code HTTP.

Les quatre lettres

Préfixe

Ce qu’il possède

La page correspondante

APIE

API générique, validation et ressources partagées

Codes d’assistance APIE

MAIL

Vérification et livraison des e-mails

Codes d’assistance MAIL

MARL

Marl : discussion, fichiers et modèle amont

Codes d’assistance MARL

QUOS

Contrats et compatibilité QuavernOS

Codes d’assistance QUOS

QVBK

Quavblok : liaison de compte Minecraft et routes serveur

Codes d’assistance QVBK

QVST

Quavsit : API de transport, données amont et quotas

Codes d’assistance QVST

SCTY

Authentification, autorisation, sécurité et blocages

Codes d’assistance SCTY

STRP

Stripe et facturation

Codes d’assistance STRP

Tout nouveau préfixe compte exactement quatre lettres ASCII majuscules, possède un propriétaire documenté, et ne réutilise jamais un code existant.

Le chiffre de classe

Le chiffre qui suit les lettres décrit la cause, pas le statut HTTP. Une limitation de cadence ordinaire est APIE1-0429 ; un quota quotidien épuisé est APIE1-1429. Les deux sont des HTTP 429, et ce ne sont pas le même problème.

Chiffre

Classe

Ce que cela signifie pour vous

0

Réellement inconnue ou non classée

Quavern n’est pas parvenu à classer cette panne. Envoyez à l’assistance le code, l’heure avec son fuseau, et ce que vous étiez en train de faire.

1

Requête ou action client

Vérifiez ce que vous avez envoyé et l’état du compte : la requête elle-même, un quota, ou l’objet qu’elle désigne. Corriger cela puis réessayer suffit normalement.

2

Serveur Quavern ou une de ses dépendances

Rien de ce que vous avez fait n’en est la cause. Patientez un instant puis réessayez. Si cela persiste, envoyez à l’assistance le code et l’heure : c’est ce qui permet de retrouver l’incident dans les journaux.

3

Authentification, autorisation ou sécurité

Reconnectez-vous, ou demandez l’accès nécessaire à la personne qui administre votre organisation. L’assistance ne contournera jamais un contrôle d’accès à votre place.

4

Blocage automatique de sécurité ou anti-abus

Une protection automatique a arrêté la requête. L’assistance ne peut pas la lever sur-le-champ ; décrivez ce que vous faisiez et le dossier sera transmis à l’équipe sécurité.

5

Blocage ou bannissement décidé par une personne

Une personne chez Quavern a pris cette décision. Écrivez à l’assistance : seul un réexamen peut la changer, aucun nouvel essai automatique n’y parviendra.

6

Maintenance déclarée

Quavern se trouve dans une fenêtre de maintenance annoncée. Consultez https://status.quavern.net et réessayez une fois la fenêtre close.

7

Arrêt, déplacement, ou mise à jour requise

Ce que vous avez appelé s’est arrêté, a été déplacé, ou exige une version plus récente. Suivez l’avis de migration ou de mise à jour plutôt que de réessayer.

8

Appareil ou réseau incompatible

Votre appareil, navigateur, réseau ou proxy n’est pas accepté par ce point d’entrée. Relevez les quatre et indiquez-les à l’assistance — sans jamais y joindre de secret.

9

Incident indéterminé dans un service connu

Un service connu de Quavern a échoué d’une manière qu’il n’a pas su classer. Conservez le code et l’heure et transmettez-les à l’assistance.

Où vous le voyez

Une erreur d’API a cette forme, et le code se trouve dans error.code :

{
  "error": {
    "code": "APIE1-0429",
    "reason": "rate_limited",
    "message": "Too many requests. Try again later.",
    "details": {}
  }
}

code et reason sont deux contrats stables sur lesquels vous pouvez bâtir. message est une explication technique destinée à une personne qui lit des journaux : ne le traduisez jamais et n’y branchez aucune logique.

Ce que Quavern promet au sujet d’un code

  1. Un code ne change jamais de sens après sa publication.

  2. Deux conditions différentes ne partagent jamais un code.

  3. Une nouvelle condition est ajoutée au registre et couverte par un test.

  4. Une condition retirée reste documentée comme obsolète, et son code n’est jamais recyclé. Un ticket citant un code de l’an dernier renvoie toujours à ce qu’il signifiait alors.

Ce qu’il faut envoyer à l’assistance

  • le code et le reason qui l’accompagne

  • le statut HTTP de la réponse

  • l’heure, avec son fuseau horaire

  • la route et la méthode appelées

  • le produit et sa version

  • de quoi reproduire le problème — sans aucun secret

Écrivez à [email protected]. L’assistance Quavern ne vous demandera jamais un mot de passe, un jeton, une clé d’API ou des données de carte bancaire complètes. Un message qui se réclame de Quavern et demande l’un de ces éléments ne vient pas de Quavern.

État des services : https://status.quavern.net.

Référence d’aide Quavern : quavern-support-codes/fr

Avez-vous trouvé la réponse à votre question ?