Accounts and webhooks

A project’s API keys, usage and webhook subscriptions, from a dashboard session.

Try it from this page

The "Try" button calls the API from your browser. Without a key, the call counts against the anonymous quota (100 calls per day and per IP address); with a key in the Authorization field, the quota rises to 1,000. The key stays in your browser. Get a key

My subscriptions to new versions (e-mail)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/abonnements"

{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "dataset": "string"    }  ]}

Remove a dataset from my subscriptions to new versions (e-mail) (idempotent)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/moi/abonnements/geographie"

Empty

State of a dataset in my subscriptions to new versions (e-mail)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/abonnements/geographie"

{  "active": true,  "created_at": "2019-08-24T14:15:22Z",  "dataset": "string"}

Add a dataset to my subscriptions to new versions (e-mail) (idempotent)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X PUT "https://example.com/v1/moi/abonnements/geographie"

{  "active": true,  "created_at": "2019-08-24T14:15:22Z",  "dataset": "string"}

Projet, mode et portées de la clé API qui appelle

Authorization

apiKey

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/cle"

{  "mode": "test",  "name": "string",  "project_id": "string",  "scopes": [    "string"  ]}

Version des conditions d’utilisation et acceptation du compte

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/conditions"

{  "accepted": true,  "version": "string"}

Accepter la version courante des conditions d’utilisation

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

version*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/moi/conditions" \  -H "Content-Type: application/json" \  -d '{    "version": "string"  }'

{  "accepted": true,  "version": "string"}

My favourites

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/favoris"

{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "dataset": "string"    }  ]}

Remove a dataset from my favourites (idempotent)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/moi/favoris/geographie"

Empty

State of a dataset in my favourites

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/favoris/geographie"

{  "active": true,  "created_at": "2019-08-24T14:15:22Z",  "dataset": "string"}

Add a dataset to my favourites (idempotent)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

jeu*string

Dataset identifier (catalogue /v1/jeux).

Response Body

`application/json`

curl -X PUT "https://example.com/v1/moi/favoris/geographie"

{  "active": true,  "created_at": "2019-08-24T14:15:22Z",  "dataset": "string"}

Questions d’accueil et réponses du compte

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

`application/json`

curl -X GET "https://example.com/v1/moi/onboarding"

{  "answers": {    "property1": "string",    "property2": "string"  },  "finished": true,  "questions": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

Enregistrer une réponse d’accueil (idempotent)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

question*string

Value in

"connu"
"profil"
"specialite"
"fin"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

answer*string

Response Body

`application/json`

curl -X PUT "https://example.com/v1/moi/onboarding/connu" \  -H "Content-Type: application/json" \  -d '{    "answer": "string"  }'

Empty

Supprimer un projet : clés révoquées, webhooks supprimés (irréversible)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/projets/string"

Empty

Project dashboard: keys, usage, log, webhooks

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Response Body

`application/json`

curl -X GET "https://example.com/v1/projets/string"

{  "calls": [    {      "created_at": "2019-08-24T14:15:22Z",      "duration_ms": 0,      "id": 0,      "key_id": "string",      "method": "string",      "path": "string",      "prefix": "string",      "status": 0    }  ],  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "keys": [    {      "created_at": "2019-08-24T14:15:22Z",      "daily_limit": 0,      "disabled_at": "2019-08-24T14:15:22Z",      "disabled_reason": "string",      "expires_at": "2019-08-24T14:15:22Z",      "id": "string",      "last_used_at": "2019-08-24T14:15:22Z",      "mode": "test",      "name": "string",      "prefix": "sk_221_pay_test_k3m9x2p",      "revoked_at": "2019-08-24T14:15:22Z",      "rotated_from": "string",      "scopes": [        "string"      ]    }  ],  "live_enabled": true,  "name": "string",  "payments_calls": {    "errors_today": 0,    "last_14_days": [      {        "count": 0,        "day": "string"      }    ],    "today": 0  },  "quota": {    "account_daily_limit": 0,    "account_used": 0,    "anonymous_daily_limit": 0,    "key_daily_limit": 0,    "key_limit": 0,    "rate_limit_per_minute": 0,    "reset": "string",    "tier": "standard",    "verified_account_daily_limit": 0  },  "slug": "string",  "usage": [    {      "count": 0,      "day": "string",      "key_id": "string"    }  ],  "webhook_secret": "string",  "webhooks": [    {      "created_at": "2019-08-24T14:15:22Z",      "events": [        "string"      ],      "id": "string",      "local_only": true,      "modes": [        "string"      ],      "url": "string"    }  ]}

Renommer un projet (administrateurs du projet)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 60

Response Body

`application/json`

curl -X PUT "https://example.com/v1/projets/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "name": "string",  "slug": "string"}

Créer une clé API (5 clés actives au plus ; le secret n’est affiché qu’une fois)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

daily_limit?integer

Formatint64

Range1 <= value

expires_in?string

Durée de validité : never (sans expiration), 30d, 90d ou 1y.

Default"never"

Value in

"never"
"30d"
"90d"
"1y"

mode?string

test (par défaut) ou live, une fois le mode live du projet activé.

Default"test"

Value in

"test"
"live"

name*string

Length1 <= length <= 60

scopes?array<>|

Produits autorisés ; par défaut les deux.

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/v1/projets/string/cles" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "daily_limit": 0,  "disabled_at": "2019-08-24T14:15:22Z",  "disabled_reason": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "last_used_at": "2019-08-24T14:15:22Z",  "mode": "test",  "name": "string",  "prefix": "sk_221_pay_test_k3m9x2p",  "revoked_at": "2019-08-24T14:15:22Z",  "rotated_from": "string",  "scopes": [    "string"  ],  "secret": "string"}

Revoke an API key

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

keyId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/projets/string/cles/string"

Empty

Remplacer une clé API : nouvelle clé (même nom, mode, portées et quota), l'ancienne reste valide pendant le délai choisi

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

keyId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

grace*string

Validité restante de l'ancienne clé : now (révoquée tout de suite), 1h, 24h ou 7d.

Value in

"now"
"1h"
"24h"
"7d"

Response Body

`application/json`

curl -X POST "https://example.com/v1/projets/string/cles/string/rotate" \  -H "Content-Type: application/json" \  -d '{    "grace": "now"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "daily_limit": 0,  "disabled_at": "2019-08-24T14:15:22Z",  "disabled_reason": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "last_used_at": "2019-08-24T14:15:22Z",  "mode": "test",  "name": "string",  "prefix": "sk_221_pay_test_k3m9x2p",  "revoked_at": "2019-08-24T14:15:22Z",  "rotated_from": "string",  "scopes": [    "string"  ],  "secret": "string"}

Inviter une personne par e-mail (valable 7 jours, usage unique)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

Lengthlength <= 254

role*string

Value in

"admin"
"user"
"read_only"

Response Body

`application/json`

curl -X POST "https://example.com/v1/projets/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "role": "admin"  }'

{  "email": "string",  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "role": "admin"}

Retirer une invitation en attente

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

invId*string

Lengthlength <= 64

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/projets/string/invitations/string"

Empty

Mode live du projet : les clés live déplacent de l'argent réel

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Response Body

`application/json`

curl -X GET "https://example.com/v1/projets/string/live"

{  "live_enabled": true}

Activer ou désactiver le mode live du projet (administrateurs du projet ; confirmation obligatoire pour activer)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

acknowledged?boolean

Obligatoire pour activer : confirme que les clés live déplacent de l'argent réel.

live_enabled*boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/projets/string/live" \  -H "Content-Type: application/json" \  -d '{    "live_enabled": true  }'

{  "live_enabled": true}

Membres du projet et invitations en attente

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Response Body

`application/json`

curl -X GET "https://example.com/v1/projets/string/membres"

{  "invitations": [    {      "email": "string",      "expires_at": "2019-08-24T14:15:22Z",      "id": "string",      "role": "admin"    }  ],  "members": [    {      "email": "string",      "joined_at": "2019-08-24T14:15:22Z",      "name": "string",      "role": "admin",      "user_id": "string"    }  ]}

Retirer un membre ou quitter le projet (le dernier administrateur reste)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

userId*string

Lengthlength <= 64

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/projets/string/membres/string"

Empty

Changer le rôle d'un membre (le dernier administrateur reste)

Authorization

session

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

userId*string

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in

"admin"
"user"
"read_only"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/projets/string/membres/string" \  -H "Content-Type: application/json" \  -d '{    "role": "admin"  }'

{  "email": "string",  "joined_at": "2019-08-24T14:15:22Z",  "name": "string",  "role": "admin",  "user_id": "string"}

Points de terminaison webhook du projet

Authorization

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Response Body

`application/json`

curl -X GET "https://example.com/v1/projets/string/webhooks"

[  {    "created_at": "2019-08-24T14:15:22Z",    "events": [      "string"    ],    "id": "string",    "local_only": true,    "modes": [      "string"    ],    "url": "string"  }]

Ajouter un point de terminaison webhook (une URL, des événements du catalogue)

Authorization

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

Header Parameters

X-221-Mode?string

Mode affiché dans le tableau de bord : le point de terminaison reçoit les événements de ce mode.

Default"test"

Value in

"test"
"live"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

events?array<string>|

Types d’événements reçus (GET /v1/webhook-event-types) ; par défaut dataset.updated.

Items1 <= items

url*string

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/v1/projets/string/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "events": [    "string"  ],  "id": "string",  "local_only": true,  "modes": [    "string"  ],  "url": "string"}

Delete a subscription

Authorization

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

subscriptionId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/projets/string/webhooks/string"

Empty

Choisir les événements et les modes d’un point de terminaison webhook

Authorization

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

subscriptionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

events?array<string>|

Types d’événements reçus (GET /v1/webhook-event-types).

Items1 <= items

modes?array<string>|

Modes reçus : test, live, ou les deux.

Items1 <= items

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/projets/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "events": [    "string"  ],  "id": "string",  "local_only": true,  "modes": [    "string"  ],  "url": "string"}

Envoyer un événement test.ping signé au point de terminaison (3 par minute au plus)

Authorization

better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Identifiant du projet.

subscriptionId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/projets/string/webhooks/string/test"

{  "delivered": true,  "error": "string",  "event": "test.ping",  "livemode": true,  "status": 0}

Accounts and webhooks

My subscriptions to new versions (e-mail)Copy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Remove a dataset from my subscriptions to new versions (e-mail) (idempotent)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

defaultapplication/json

State of a dataset in my subscriptions to new versions (e-mail)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Add a dataset to my subscriptions to new versions (e-mail) (idempotent)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Projet, mode et portées de la clé API qui appelleCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Version des conditions d’utilisation et acceptation du compteCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Accepter la version courante des conditions d’utilisationCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

My favouritesCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Remove a dataset from my favourites (idempotent)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

defaultapplication/json

State of a dataset in my favouritesCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Add a dataset to my favourites (idempotent)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Questions d’accueil et réponses du compteCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

defaultapplication/json

Enregistrer une réponse d’accueil (idempotent)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

204

defaultapplication/json

Supprimer un projet : clés révoquées, webhooks supprimés (irréversible)Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

My subscriptions to new versions (e-mail)

Authorization

Response Body

`application/json`

`application/json`

Remove a dataset from my subscriptions to new versions (e-mail) (idempotent)

Authorization

Path Parameters

Response Body

`application/json`

State of a dataset in my subscriptions to new versions (e-mail)

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Add a dataset to my subscriptions to new versions (e-mail) (idempotent)

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Projet, mode et portées de la clé API qui appelle

Authorization

Response Body

`application/json`

`application/json`

Version des conditions d’utilisation et acceptation du compte

Authorization

Response Body

`application/json`

`application/json`

Accepter la version courante des conditions d’utilisation

Authorization

Request Body

Response Body

`application/json`

`application/json`

My favourites

Authorization

Response Body

`application/json`

`application/json`

Remove a dataset from my favourites (idempotent)

Authorization

Path Parameters

Response Body

`application/json`

State of a dataset in my favourites

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Add a dataset to my favourites (idempotent)

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Questions d’accueil et réponses du compte

Authorization

Response Body

`application/json`

`application/json`

Enregistrer une réponse d’accueil (idempotent)

Authorization

Path Parameters

Request Body

Response Body

`application/json`

Supprimer un projet : clés révoquées, webhooks supprimés (irréversible)

Authorization

Path Parameters

Response Body

`application/json`

Project dashboard: keys, usage, log, webhooks

Authorization

Path Parameters

Response Body