URL de base :
/api/v1
Aller au tableau de bord

Documentation de l'API

Points de terminaison publics / utilisateur sous /api/v1. Certaines requêtes nécessitent une authentification ou une clé API.

Authentification

Incluez votre clé API dans la requête :

  • Authorization header: Authorization: Bearer <API_KEY>
  • Or header: X-API-Key: <API_KEY>
  • Or query: ?api_key=<API_KEY> (not recommended)

Astuce : demandez une clé API à votre administrateur ou gérez vos clés depuis le tableau de bord.

Mes Organisations

GET
/api/v1/organizations/my

Lister les organisations auxquelles l’utilisateur appartient.

GET
/api/v1/organizations/{organization}

Détails pour une organisation de l’utilisateur.

POST
/api/v1/organizations

Créer une nouvelle organisation (l’utilisateur devient propriétaire).

PUT/PATCH
/api/v1/organizations/{organization}

Mettre à jour une organisation dont vous êtes propriétaire.

DELETE
/api/v1/organizations/{organization}

Supprimer une organisation dont vous êtes propriétaire.

Équipes

GET
/api/v1/organizations/{organization}/teams

Lister les équipes de votre organisation.

GET
/api/v1/organizations/{organization}/teams/{team}

Obtenir une équipe par ID.

POST
/api/v1/organizations/{organization}/teams

Créer une équipe dans une organisation.

PUT/PATCH
/api/v1/organizations/{organization}/teams/{team}

Mettre à jour les détails d’une équipe.

DELETE
/api/v1/organizations/{organization}/teams/{team}

Supprimer une équipe.

Rôles

GET
/api/v1/organizations/{organization}/roles

Lister les rôles disponibles dans l’organisation.

POST
/api/v1/organizations/{organization}/roles/{user}

Assigner ou mettre à jour le rôle d’un utilisateur.

Affiliation

GET
/api/v1/affiliate

Infos/statistiques affiliation de l’utilisateur.

GET
/api/v1/affiliate/referrals

Lister les parrainages et gains.

POST
/api/v1/affiliate/withdraw

Demander un retrait des gains.

Profil

GET
/api/v1/profile

Obtenir les données du profil utilisateur.

PUT/PATCH
/api/v1/profile

Mettre à jour vos informations (nom, avatar, paramètres).

POST
/api/v1/profile/password

Changer votre mot de passe.

Abonnements

GET
/api/v1/subscriptions

Lister les abonnements. Paramètres : search, per_page.

GET
/api/v1/subscriptions/{subscription}

Obtenir un abonnement par ID.

POST
/api/v1/subscriptions

Créer un abonnement.

PUT/PATCH
/api/v1/subscriptions/{subscription}

Mettre à jour un abonnement.

DELETE
/api/v1/subscriptions/{subscription}

Supprimer un abonnement.

Paiements

GET
/api/v1/payments

Lister les paiements. Paramètres : search, per_page.

GET
/api/v1/payments/{payment}

Obtenir un paiement par ID.

POST
/api/v1/payments

Créer un paiement.

PUT/PATCH
/api/v1/payments/{payment}

Mettre à jour un paiement.

DELETE
/api/v1/payments/{payment}

Supprimer un paiement.