Documentation de l'API

Ceci est la documentation des points d'extrémité API disponibles, qui sont construits autour de l'architecture REST. Tous les points d'extrémité API renverront une réponse JSON avec les codes de réponse HTTP standard et nécessitent une authentification Bearer via une clé API.

Obtenez votre propre clé API

URL de base

Authentification

Tous les points d'extrémité de l'API nécessitent une clé d'API envoyée par la méthode d'authentification Bearer.

Authorization: Bearer {api_key}

Exemple

curl --request GET \
--url 'https://bioup.me/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Erreurs

Notre API utilise les codes d'état HTTP conventionnels pour indiquer le succès ou l'échec d'une requête.

Exemple

{
    "errors": [
        {
            "title": "Vous n'avez pas acc\u00e8s \u00e0 l'API.",
            "status": 401
        }
    ]
}

Codes d'état

200 Requête terminée avec succès

400 Mauvaise requête - Les paramètres requis sont manquants ou invalides

401 Non autorisé - la clé API est manquante ou invalide

404 La ressource demandée n'a pas été trouvée

429 Trop de requêtes - Limite de débit dépassée

500 Erreur interne du serveur - cela signifie qu'il y a un problème de notre côté

Tous les résultats des points de terminaison de l'API fonctionnent avec le fuseau horaire UTC, sauf indication contraire.

Utilisateur

Liens

Statistiques des liens

Projets

Pixels

QR codes

Signatures

Données

Gestionnaires de notifications

Mes équipes

Membres de l'équipe

Membre de l'équipe

Journaux du compte