Aicscan Documentation

Canaux

Créer un canal

POST/v1/channels
  • webhook, discord, slack, email : créés immédiatement (201). L’URL d’un webhook doit être en https et ne désigner que des adresses publiques : les adresses privées, de bouclage, de lien local, de métadonnées cloud et réservées, les noms d’hôte locaux et les URL avec identifiants sont refusés avec 422 url_not_allowed (le DNS est revérifié à chaque envoi). Le secret de signature du webhook (webhook_secret) est renvoyé une seule fois, dans cette réponse.
  • telegram, hellome : reliés par invitation (202). Ouvrez invite.link en tant qu’administrateur du groupe dans les 10 minutes ; interrogez l’URL de Location (GET /v1/channel-invites/{token}) pour obtenir l’identifiant du canal.

Contrôles de l’offre : types de canaux (403 channel_kind_not_in_plan) et nombre de canaux (403 plan_limit_reached).

Authentification
Clé d’API (Authorization: Bearer)
Portée requise
write
  • Rejouable sans risque avec l’en-tête Idempotency-Key : voir Idempotence.

En-têtes#

  • Idempotency-Keystring

    Permet de relancer le POST sans risque pendant 24 heures.

    de 1 à 255 caractères

Corps de la requête#

  • kindstringobligatoire
    Valeurs webhook discord slack email telegram hellome
  • namestringpeut valoir null

    Refusé pour telegram et hellome.

    au plus 80 caractères
  • rolestring

    Refusé pour telegram et hellome.

    Valeurs alerts escalation
    Par défaut "alerts"
  • localestring
    Valeurs fr en
    Par défaut "fr"
  • urlstring

    webhook (https, hôte public), discord (https://discord.com/api/webhooks/…), slack (https://hooks.slack.com/services/…).

  • emailstableau de string · email

    email seulement.

    de 1 à 10 éléments

Réponses#

201Canal créé.

En-têtes de réponse

  • Locationstring
  • Idempotent-Replayedstring

    true quand la réponse est le rejeu d’une requête précédente de même Idempotency-Key.

    Valeurs true
Champs de l’objet
  • idstring · uuid
  • kindstring
    Valeurs webhook discord slack email telegram hellome
  • namestringpeut valoir null
  • statestring
    Valeurs active disabled
  • rolestring
    Valeurs alerts escalation
  • targetstringpeut valoir null

    Destination masquée, par exemple https://hooks.example.com/aicscan, a***@example.com.

  • created_atstring · date-time
  • disabled_atstring · date-timepeut valoir null
  • disabled_reasonstringpeut valoir null
  • last_success_atstring · date-timepeut valoir null
  • linked_atstring · date-timepeut valoir null
  • webhook_secretstringpeut valoir null

    Webhook seulement : secret de signature HMAC-SHA256 (whsec_…), affiché une seule fois. Vérifiez X-Signature sur X-Timestamp et le corps ; refusez les horodatages de plus de 5 minutes. null dans un rejeu idempotent.

202Invitation créée (Telegram, helloMe).

En-têtes de réponse

  • Locationstring

    /v1/channel-invites/{token}

Champs de l’objet
  • kindstring
    Valeurs telegram hellome
  • statusstring
    Valeurs pending
  • inviteobject
    Champs de l’objet
    • tokenstring
    • linkstring · uri
    • expires_atstring · date-time
    • expires_in_minutesinteger
4xx · 5xxErreur.

Erreur au format standard : voir Erreurs.

Aicscan ne vous demandera jamais de vous connecter à un wallet, de signer une transaction ni d’envoyer des fonds.

aicscan.io · Statut · openapi.yaml