Twimi
API Twimi v1
API Twimi v1

Service

Server
Download schema

État du service, vérification d'une clé et consommation du mois.

État du service

GET
https://api-dev.atwimi.com
/v1/health

Sans clé. api est la version de l'adresse (/v1), version celle de la documentation.

État du service › Responses

200

Service en marche

Le déploiement auquel la clé donne accès

GET
https://api-dev.atwimi.com
/v1/me
Bearer (sk_test_… / sk_live_…)
or
Bearer (pk_test_… / pk_live_…)

Sert à vérifier une clé. Clé publique : depuis une page déclarée. Clé secrète : côté serveur.

Le déploiement auquel la clé donne accès › Responses

Le déploiement de la clé ; partner vaut null pour un client direct de Twimi.

Consommation du mois (clé secrète)

GET
https://api-dev.atwimi.com
/v1/usage
Bearer (sk_test_… / sk_live_…)

Clé secrète seulement. opened : conversations ouvertes ; counted : conversations décomptées du forfait (une reprise sous 30 min n'est pas décomptée).

Consommation du mois (clé secrète) › query Parameters

period
​string | null

Mois « AAAA-MM » (défaut : le mois en cours)

Mois « AAAA-MM » (défaut : le mois en cours)

Consommation du mois (clé secrète) › Responses

Consommation du mois. counted ≥ opened : chaque tranche de 5 réponses parlées compte en plus.

Avatars