Documentation de la API

Cette est a documentation des endpoints de la API disponibles, que sont construídos dans torno de la arquitetura REST. Tous les endpoints de la API retornarão une réponse JSON avec les codes de réponse HTTP défaut et precisam de une Authentification Bearer via une Clé de API.

 

Authentification

Tous les endpoints de la API requerem une clé de API enviada par le método de authentification Bearer.

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

Erreurs

Notre API usa codes de status HTTP convencionais pour indicar o succès ou a falha de une Requête.

{
    "errors": [
        {
            "title": "Vous ne comporte acc\u00e8s \u00e0 API.",
            "status": 401
        }
    ]
}
200 Requête effectuée avec succès
400 Requête invalide : paramètres obligatoires manquants ou invalides
401 ne autorizado: a clé de API est ausente ou est invalide
404 O fonctionnalité solicitado ne a été trouvé
429 Muitas requisições: limite de requisições excedido
500 Erreur interne du serveur : cela signifie qu’il y a un problème de notre côté
Tous les résultats du point de terminaison de l’API utilisent le fuseau horaire UTC, sauf indication contraire.
Utilisateur
Liens
Statistiques de liens
Titre
Pixels
Pages de introduction
codes QR
Signatures
Date
Notifications
Domaines personnalisés
Minhas équipes
Membres de l’équipe
Membre de l’équipe
Journaux du compte