Organisations

Les organisations sont une partie essentielle de Shunter — la raison même de l'existence de l'API de Shunter est de permettre la gestion de son organisation de facon sécurisée. Sur cette page, nous allons explorer les différents points de terminaison des organisations que vous pouvez utiliser de manière programmatique. Nous examinerons comment retrouver, créer, mettre à jour et supprimer des organisations.

L'objet organisation

L'objet organisation contient toutes les informations à propos de votre organisation, comme son nom, sa date de création et bien d'autre.

Propriétés

Name
_id
Type
string
Description
Identifiant unique de votre organisation.
Name
_createdAt
Type
string
Description
Le timestamp unix en seconde de la date de création de l'organisation.
Name
_nameTag
Type
string
Description
Le tag unique de l'organisateur, il pourra être utilisé à la place de _id dans les requêtes.
Name
name
Type
string
Description
Le nom de l'organisateur.
Name
description
Type
string
Description
La description de l'organisateur.
Name
status
Type
enum
Description
Le statut d'une organisation peut être enabled ou disabled

Propriétés optionnelles

Name
parentId
Type
string
Description
The _id of the parent organizer.
Name
media
Type
object
Description
The image media.
Propriétés
Name
media._id
Type
string
Description
The _id of the media.
Name
media.mediaUrl
Type
string
Description
The media url.

GET/v1/organizers/:_id

Récupérer votre organisation

Ce point de terminaison vous permet de retrouver les informations de votre organisation. Vous devez renseigner l'_id de l'organisation pour laquelle vous avez crée une clé API.

Paramètres

Aucun paramètre.

Requête

GET

/v1/organizers/:_id

curl -G https://api.shunter.fr/v1/organizers/:_id \
  -H "Authorization: X-API-KEY {token}" \

Réponse

    {
      "id": "65537dd1d454911617ac43ce",
      "_createdAt": 1699970513,
      "_nameTag": "arrivalevents",
      "name": "Arrival Events",
      "description": "Faire des évènements toujours plus beaux.",
      "status": "enabled",
    }

PATCH/v1/organizers/:_id

Mettre à jour votre organisation

Ce point de terminaison permet de mettre à jour une organisation.

Propriétés optionnelles

Name
_nameTag
Type
string
Description
Le tag unique de l'organisateur, il pourra être utilisé à la place de _id dans les requêtes.
Name
name
Type
string
Description
Le nom de l'organisateur.
Name
description
Type
string
Description
La description de l'organisateur.
Name
status
Type
enum
Description
Le statut d'une organisation peut être enabled ou disabled

Name
media
Type
object
Description
The image media.
Propriétés
Name
media._id
Type
string
Description
The _id of the media.

Requête

PUT

/v1/organizers/:_id

curl -X PATCH https://api.shunter.fr/v1/organizers/65537dd1d454911617ac43ce \
  -H "Authorization: X-API-KEY {YOUR_API_KEY}" \
  -d name="Arrival Paris"

Response

 {
      "id": "65537dd1d454911617ac43ce",
      "_createdAt": 1699970513,
      "_nameTag": "arrivalevents",
      "name": "Arrival Paris",
      "description": "Faire des évènements toujours plus beaux.",
      "status": "enabled",
    }

DELETE/v1/organizers/:_id

Supprimer votre organisation

Ce point de terminaison vous permet de supprimer votre organisation. Cela ne fonctionnera que si aucune transaction n'a été réalisée pour le compte de cette organisation.

Requête

DELETE

/v1/organizers/65537dd1d454911617ac43ce

curl -X DELETE https://api.shunter.fr/v1/organizers/65537dd1d454911617ac43ce \
  -H "Authorization: X-API-KEY {YOUR_API_KEY}"