> ## Documentation Index
> Fetch the complete documentation index at: https://www.zippendo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# SDKs

> Bibliothèques clientes Zippendo gratuites pour TypeScript, Python, PHP, Go et Ruby.

Les SDK permettent à votre développeur de connecter votre boutique en ligne, votre ERP ou votre système d'entrepôt à Zippendo en quelques lignes de code, sans écrire d'appels HTTP bruts. Ce sont des bibliothèques clientes gratuites pour TypeScript, Python, PHP, Go et Ruby, et elles couvrent tous les endpoints de la référence de l'API.

<CardGroup cols={2}>
  <Card title="TypeScript / JavaScript" icon="package" href="https://www.npmjs.com/package/@zippendo/sdk">
    npm: `@zippendo/sdk`
  </Card>

  <Card title="Python" icon="package" href="https://pypi.org/project/zippendo">
    PyPI: `zippendo`
  </Card>

  <Card title="PHP" icon="package" href="https://packagist.org/packages/zippendo/zippendo-php">
    Packagist: `zippendo/zippendo-php`
  </Card>

  <Card title="Go" icon="package" href="https://github.com/zippendo/zippendo-go">
    `github.com/zippendo/zippendo-go`
  </Card>

  <Card title="Ruby" icon="package" href="https://rubygems.org/gems/zippendo">
    RubyGems: `zippendo`
  </Card>
</CardGroup>

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install @zippendo/sdk
  ```

  ```bash pip theme={null}
  pip install zippendo
  ```

  ```bash composer theme={null}
  composer require zippendo/zippendo-php
  ```

  ```bash go theme={null}
  go get github.com/zippendo/zippendo-go
  ```

  ```bash gem theme={null}
  gem install zippendo
  ```
</CodeGroup>

## S'authentifier et effectuer votre premier appel

Créez un jeton d'API sous **Paramètres de l'API** (ouvrez le menu de l'organisation en bas de la barre latérale, puis **Gérer**). Il commence par `zipp_` et est envoyé comme jeton Bearer. L'URL de base est `https://api.zippendo.com` par défaut.

<CodeGroup>
  ```ts TypeScript theme={null}
  import { Configuration, ShipmentsApi } from "@zippendo/sdk"

  const shipments = new ShipmentsApi(
    new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN })
  )

  const page = await shipments.listShipments({ orgId: "org_8f3kd92ld0", page: 1, limit: 50 })
  console.log(page.data)
  ```

  ```python Python theme={null}
  import os
  import zippendo

  config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
  with zippendo.ApiClient(config) as client:
      page = zippendo.ShipmentsApi(client).list_shipments("org_8f3kd92ld0", page=1, limit=50)
      print(page.data)
  ```

  ```php PHP theme={null}
  <?php
  require_once __DIR__ . "/vendor/autoload.php";

  $config = Zippendo\Sdk\Configuration::getDefaultConfiguration()
      ->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));

  $shipments = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(), $config);
  $page = $shipments->listShipments("org_8f3kd92ld0", 1, 50);
  ```

  ```go Go theme={null}
  client := zippendo.NewAPIClient(zippendo.NewConfiguration())
  ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))

  page, _, err := client.ShipmentsAPI.ListShipments(ctx, "org_8f3kd92ld0").Page(1).Limit(50).Execute()
  ```

  ```ruby Ruby theme={null}
  require "zippendo"

  Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
  page = Zippendo::ShipmentsApi.new.list_shipments("org_8f3kd92ld0", page: 1, limit: 50)
  ```
</CodeGroup>

<Info>
  Chaque appel nécessite l'ID de votre organisation (`orgId`). Un jeton d'API appartient à une seule organisation, et les appels pour toute autre organisation sont refusés. Pour retrouver l'ID, appelez `verifyApiToken` sur `TokensApi` avec votre jeton : la réponse inclut `orgId`. Voir le [démarrage rapide de l'API REST](/docs/fr/quickstarts/rest-api).
</Info>

## Ressources

Chaque SDK dispose d'un client par ressource, comme `ShipmentsApi`, `OrdersApi`, `CarriersApi`, `AddressesApi`, `RulesApi`, `WebhooksApi` et `TokensApi`, qui correspondent aux groupes de la référence de l'API. La pagination (`page`/`limit`), les corps de requête et la gestion des erreurs (les erreurs contiennent `{ code, error, message }`) sont décrits dans le README de chaque SDK.

## Référence

Parcourez tous les endpoints et testez des requêtes dans le playground, dans la [référence de l'API](/docs/api-reference/overview).

<Tip>
  Vous développez avec des agents d'IA ? Le [**serveur MCP**](/docs/fr/mcp/overview) donne à Claude, Cursor, ChatGPT et à d'autres outils d'IA les mêmes actions après une connexion dans le navigateur, sans SDK à installer.
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.