API

Deux points de terminaison, en lecture seule. Ils renvoient ce que le pipeline a trouvé pour votre compte client : les entreprises qu'il a lues, et celles qui ont franchi toutes les étapes. Tout ce que le tableau de bord affiche sur ces deux écrans est disponible ici, en JSON, pour ce compte client et pour aucun autre.

Authentification

Créez une clé dans le tableau de bord, sous Paramètres. Elle ne s'affiche qu'une seule fois, car seule son empreinte est conservée : aucun écran ne peut donc la révéler ensuite. Envoyez-la comme jeton bearer.

curl https://knockwire.com/api/reads \
  -H "Authorization: Bearer kw_live_..."

Une requête sans clé, avec un en-tête mal formé ou avec une clé révoquée reçoit un 401 accompagné d'un corps JSON qui précise lequel des trois. Une clé lit toutes les entreprises et tous les refus de son compte client : elle mérite donc le même soin qu'un mot de passe. Révoquer une clé dans les Paramètres prend effet dès la requête suivante.

Points de terminaison

• GET /api/reads Toutes les entreprises que le pipeline a examinées, les plus récentes d'abord. Filtrez avec outcome=refuse ou outcome=knock. Par défaut, les refus, parce que ce sont eux qui méritent la lecture. limit vaut 100 par défaut et est plafonné à 500.
• GET /api/prospects Les entreprises qui ont franchi les quatre étapes, avec leur score et le raisonnement qui le justifie.

Il n'existe pas de paramètre de compte client. La clé décide des données renvoyées, et une requête qui porte tenant= est refusée par un 400 plutôt que silencieusement ignorée.

Ce que cette API ne fait pas encore

Écrit ici pour que personne ne le découvre au milieu d'une intégration.

• Aucune écriture. Aucun point de terminaison n'accepte une liste d'entreprises. La découverte lit ses propres sources.
• Aucun envoi. Rien dans cette API ne peut approuver ni délivrer un message. L'approbation est le fait d'une personne dans le tableau de bord, et c'est un choix de produit plutôt qu'une fonctionnalité manquante.
• Aucun préfixe de version. Les chemins ne sont pas versionnés tant que leur forme bouge encore. Quand cela changera, ce sera annoncé dans le journal des changements.
• Aucune limite de débit publiée. Il n'existe aujourd'hui aucune limitation par clé. Restez raisonnable, et attendez-vous à en voir apparaître une avant qu'elle ne soit nécessaire plutôt qu'après.