L'API publique de ControlResell

Générer votre clé d'API

Les clés se créent dans l'application, avec votre session. Une clé ne peut pas en créer, lister ou révoquer une autre.

1. Connectez-vous à l'application ControlResell sur le web.
2. Ouvrez Paramètres, puis Développeurs.
3. Créez une clé : donnez-lui un nom, cochez au moins une portée et, si vous le souhaitez, une date d'expiration (5 ans au plus).
4. Copiez le secret tout de suite : il n'est affiché qu'une seule fois.

Gérer mes clés d'API

Le secret commence par cr_live_. Gardez-le comme un mot de passe : ControlResell n'en conserve qu'une empreinte et ne peut pas vous le montrer à nouveau. En cas de doute, révoquez la clé et créez-en une autre.

Envoyez la clé dans l'en-tête Authorization de chaque appel. Exemple pour lire votre profil :

curl https://api.controlresell.com/api/public/v1/me \
  -H "Authorization: Bearer cr_live_..."

Vous pouvez avoir 10 clés actives au plus, chacune révocable à tout moment.

Portées disponibles

• accounts:read – Lecture des comptes de marketplace
• items:read – Lecture des articles et de leurs annonces
• items:write – Écriture sur les articles
• orders:read – Lecture des commandes
• conversations:read – Lecture des conversations
• conversations:write – Écriture sur les conversations
• customers:read – Lecture des clients
• webhooks:read – Lecture des webhooks
• webhooks:write – Écriture sur les webhooks

Documentation de l'API

La référence interactive (Swagger) et la spécification OpenAPI sont publiques et générées depuis l'API en production.

• Ouvrir la documentation Swagger
• Télécharger la spécification OpenAPI

L'API est versionnée (/api/public/v1). La v1 n'évolue que par ajouts ; en cas de rupture, une v2 est ouverte et la v1 reste disponible au moins douze mois après l'annonce.

SDK et CLI officiels

Des SDK générés depuis la spécification et une CLI, en open source sur GitHub.

• TypeScriptcontrolresell/typescript-sdkVoir le dépôt

  npm

  npm install controlresell-sdk

• Pythoncontrolresell/python-sdkVoir le dépôt

  PyPI (import controlresell)

  pip install controlresell-sdk

• Gocontrolresell/go-sdkVoir le dépôt

  Go modules (Git tag v1.0.0)

  go get github.com/controlresell/[email protected]

• Javacontrolresell/java-sdkVoir le dépôt

  Maven Central (pom.xml)

  <dependency>
    <groupId>com.controlresell</groupId>
    <artifactId>java-sdk</artifactId>
    <version>1.0.0</version>
  </dependency>

• Kotlincontrolresell/kotlin-sdkVoir le dépôt

  Maven Central (Gradle)

  implementation("com.controlresell:kotlin-sdk:1.0.0")

• C#controlresell/csharp-sdkVoir le dépôt

  NuGet (.NET)

  dotnet add package ControlResell.Sdk

• Swiftcontrolresell/swift-sdkVoir le dépôt

  Swift Package Manager (Git tag 1.0.0)

  .package(url: "https://github.com/controlresell/swift-sdk", from: "1.0.0")

• PHPcontrolresell/php-sdkVoir le dépôt

  Packagist (Composer)

  composer require controlresell/sdk

• Rustcontrolresell/rust-sdkVoir le dépôt

  crates.io (Cargo)

  cargo add controlresell-sdk

• Ligne de commandecontrolresell/cliVoir le dépôt

  macOS / Linux

  curl -fsSL https://github.com/controlresell/cli/releases/latest/download/install.sh | sh

  Windows (PowerShell)

  & { $f = Join-Path $env:TEMP ([IO.Path]::GetRandomFileName() + '.ps1'); try { Invoke-WebRequest -UseBasicParsing 'https://github.com/controlresell/cli/releases/latest/download/install.ps1' -OutFile $f; & ([scriptblock]::Create([IO.File]::ReadAllText($f))) } finally { Remove-Item $f -ErrorAction SilentlyContinue } }

Installez le SDK de votre langage avec la commande ci-dessous, ou la CLI avec son script d'installation. La version 1.0.0 correspond à l'API v1.