Référence de l’API · v1
L’API de Sway
Une API REST pour les agents d’IA et les développeurs tiers, qui lisent les données de Sway et agissent sur elles : espaces de travail, comptes bancaires, factures, paiements et grand livre.
- URL de base
https://api.business.swayapp.io/v1- Authentification
Authorization: Bearer <token>- Format
- JSON · OpenAPI 3.1.0 · 19 ressources
Guides
Comment envoyer une clé, lire une liste entière et traiter une erreur, avec du code à copier.
AuthentificationEnvoyez une clé API comme jeton bearer, limitez-la par des portées aux ressources dont votre logiciel a besoin, et remplacez-la avant qu’elle expire.PaginationLisez une liste entière page par page avec son curseur, obtenez des éléments par leur ID, ne gardez que les champs utiles, et parcourez les résultats de recherche.ErreursLisez le statut et le code stable d’une erreur, trouvez sa cause dans ses détails, restez sous la limite de requêtes, et ne relancez que ce qui peut l’être sans risque.Connecteur ClaudeConnectez Claude Desktop à vos espaces de travail Sway avec une clé API, puis interrogez Claude sur vos factures, vos transactions bancaires et votre grand livre, et laissez-le agir quand vous l’autorisez.
Interrogez Claude sur vos données SwayLe connecteur Sway pour Claude Desktop lit vos espaces de travail via l’API, avec une clé que vous limitez à ce que Claude peut voir. Installer le connecteur Claude
Ressources
Chaque ressource a sa propre page : ses endpoints, son objet, et un exemple de chaque requête et de chaque réponse.
Workspace
- WorkspacesA workspace holds the bank accounts, invoices, payments and accounting of one company.3 endpoints
- MembershipsA membership gives a user a role in a workspace.3 endpoints
- InvitationsAn invitation asks a person, by email, to join a workspace with a given role.6 endpoints
- ConsentsA consent lets Sway read the data of bank accounts or initiate payments from them.7 endpoints
Banking
- Bank accountsA bank account, connected through a consent or managed offline, holds its transactions and past balances.15 endpoints
- Currency exchangesA currency exchange holds the exchange rates from one base currency to other currencies.1 endpoint
Billing
- InvoicesAn invoice is a sales invoice or a supplier bill of the workspace.12 endpoints
- CounterpartiesA counterparty is a customer or a supplier the workspace trades with.6 endpoints
- ProductsA product is a good or a service with the sale and purchase details used on invoices.5 endpoints
Payments
- PaymentsSummarize a payment before you create or initiate it.1 endpoint
- Draft paymentsA draft payment is a payment prepared in Sway and not yet sent to the bank.4 endpoints
- Initiated paymentsAn initiated payment is a payment sent to the bank for execution.3 endpoints
Accounting
- Ledger entriesA ledger entry books an amount to an account of the chart of accounts.6 endpoints
- Chart of accountsA chart of accounts lists the accounts and the account groups of the workspace accounting.11 endpoints
- Tax typesA tax type sets a tax rate and the accounts that book the tax.4 endpoints
- Account coding rulesAn account coding rule codes the bank transactions that match its conditions.11 endpoints
Files and account
Notes de version marquées API
Tous les changements d’APIJournal des changements de l’API
- Core Services 1.225.0NouveauA documented openapi.json now describes the Sway API with each release
- Core Services 1.225.0NouveauThe API reference now documents the shared types
- Core Services 1.225.0NouveauThe API reference now points to the api.business.swayapp.io domain
- Core Services 1.222.0CorrectifImproved handling of pagination edge cases
- Core Services 1.221.0NouveauUpload bank statements to a bank account and parse their transactions directly through the API
- Core Services 1.220.0NouveauUpload invoices, bills and bank statements straight through the API
- Core Services 1.216.0CorrectifInvoice search returns receivable invoices too, and finds an invoice by its counterparty name
- Web App 1.45.0NouveauA new developer page lets you create, view and revoke your API keys, with scopes and expiry of your choice
- Core Services 1.215.0NouveauYou can now create API keys with their own expiry date and permission scopes
- Core Services 1.211.0NouveauAdd support to download exported files
- Core Services 1.207.0NouveauSway now offers a REST API with API key support, making it possible to integrate Sway with external tools and services
Chaque entrée mène à la version qui l’a livrée, avec tous les autres changements de cette version.
Construisez sur vos propres données.
Créez un compte, ouvrez Profil › Développeur et créez une clé limitée aux ressources dont vous avez besoin. Une question sur une intégration ? L’équipe y répond lors d’un appel.