This document is intended for distributors who intend to automate their business with QBS.
\nVersion 1 of the QBS API is structured around REST, HTTP, and JSON. API endpoint URLs are organised around resources, such as orders or products. It uses HTTP methods for indicating the action to take on a resource, and HTTP status codes for expressing error states.
\nThe API is accessed using a base URL api.qbssoftware.com. In addition, URL paths should begin with /api/v1 to specify version 1 of the API. Generally, the URL will be in the form https://api.qbssoftware.com/api/v1/. All API calls should be made over HTTPS.
\nFor testing purposes, we have created the https://api-test.qbssoftware.com endpoint. The same rules apply, as with Base URL, i.e., adding versioning and connecting via HTTPS. You will see this test URL used extensively in any example requests.
\nAll requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Api-Token.
\nYour API key can be found in your account on https://app.qbssoftware.com
\nThe API uses HTTP status codes to indicate an error has occurred while processing a request. There are four main error status codes used by the API:
\n403 - The request could not be authenticated or the authenticated user is not authorized to access the requested resource.
\n404 - The requested resource does not exist.
\n422 - The request could not be processed, usually due to a missing or invalid parameter.
\n429 - The user has sent too many requests in a given amount of time (\"rate limiting\") - contact support or account manager for more details.
\nOur API has a rate limit of 5 requests per second per account.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Base URL","slug":"base-url"},{"content":"Test URL","slug":"test-url"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"16273967","collectionId":"4ad35257-eadb-4394-a366-2306c0e14158","publishedId":"TzeWJ9Av","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5391bf"},"publishDate":"2021-06-30T08:33:12.000Z"},"item":[{"name":"Orders","item":[{"name":"Place Order","id":"0d362c3a-63cc-488e-a7b0-32c22af9d5a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Generate a list of vendors. For best performance use the limit and offset parameters to retrieve vendors in batches.
\n","urlObject":{"protocol":"https","path":["api","v1","vendors"],"host":["api-test","qbssoftware","com"],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"63ebec5d-8f6e-4db5-8121-d6a3b1ce2a80","name":"Retrieve Vendor list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Aperçu
Passez au numérique avec Docusign. Nous vous aiderons à vous développer, même à l'échelle mondiale. C'est facile de commencer et de grandir lorsque vous choisissez ce que Forrester Research* dit être la marque la plus forte et le leader en part de marché : [Docusign] devient un verbe. Électroniquement signez, et maintenant préparez, agissez et gérez des accords pour offrir de superbes expériences à vos clients et employés.
Avec Docusign, vous obtenez bien plus que la signature d'un document. Notre plateforme automatise l'ensemble du processus d'accord, s'intègre aux systèmes que vous utilisez déjà et offre une valeur ajoutée supplémentaire à mesure que votre entreprise se développe.
Découvrez d'autres façons dont Docusign peut vous aider à augmenter la productivité et les revenus tout en réduisant le temps et les coûts administratifs. Ainsi, vous pouvez passer moins de temps à traquer les accords et vous concentrer plutôt sur la croissance de votre entreprise.
Fonctionnalités clés
Accès aux documents à l'échelle du système:
Überblick
Gehen Sie mit Docusign digital. Wir helfen Ihnen, selbst auf globaler Ebene zu wachsen. Es ist einfach zu starten und einfach zu wachsen, wenn Sie das wählen, was Forrester Research* als die stärkste Marke und Marktführer bezeichnet: [Docusign] wird zum Verb. Elektronisch unterzeichnen, und jetzt Vereinbarungen vorbereiten, handeln und verwalten, um großartige Erlebnisse für Ihre Kunden und Mitarbeiter zu bieten.
Mit Docusign erhalten Sie viel mehr als nur das Unterzeichnen eines Dokuments. Unsere Plattform automatisiert den gesamten Vereinbarungsprozess, integriert sich in die von Ihnen bereits verwendeten Systeme und bietet zusätzlichen Mehrwert, während Ihr Unternehmen wächst.
Erfahren Sie, wie Docusign die Produktivität und den Umsatz steigern und gleichzeitig die administrativen Zeiten und Kosten reduzieren kann. So können Sie weniger Zeit damit verbringen, Vereinbarungen nachzugehen, und sich stattdessen darauf konzentrieren, Ihr Unternehmen auszubauen.
Wichtige Funktionen
Dokumentenzugriff systemweit:
Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"from_date","value":"2021-09-01"},{"description":{"content":"Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"to_date","value":"2021-09-09"}],"variable":[]}},"response":[],"_postman_id":"7b5d5120-2b69-4f90-8ef5-48685550799b"}],"id":"0770666d-8034-494e-aba3-54c7d3829479","_postman_id":"0770666d-8034-494e-aba3-54c7d3829479","description":""},{"name":"Renewals","item":[{"name":"Retrieve Renewals","id":"166d2a91-08dc-47fb-b966-114bac88e27e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Options: [-1 (Overdue), 0-7 (days), 0-14 (days), 0-30 (days), 0-90 (days), 31-60 (days), 61-90 (days), n (days)
\n","type":"text/plain"},"key":"due_in","value":"due_in"}],"variable":[]}},"response":[{"id":"37a1f027-1719-476e-9547-35f50914ea17","name":"Retreive Renewals by Due In","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"from_date","value":"from_date"}],"variable":[]}},"response":[{"id":"2a297e82-2267-4ce8-acbf-13fbe31c736d","name":"Retreive Renewals by From Date","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Format: YYYY-MM-DD
\n","type":"text/plain"},"key":"to_date","value":"to_date"}],"variable":[]}},"response":[{"id":"963528c9-d6d1-46f3-ab78-a55b7eebb782","name":"Retreive Renewals by To Date","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Api-Token","value":"Options: [P30D | P60D | P90D]
\n"}]},"url":"https://api-test.qbssoftware.com/api/v1/renewal/alert","urlObject":{"protocol":"https","path":["api","v1","renewal","alert"],"host":["api-test","qbssoftware","com"],"query":[],"variable":[]}},"response":[{"id":"30aaa5ac-6e96-47e9-9e93-59fbc8bfbcaa","name":"Place Alert","originalRequest":{"method":"POST","header":[{"key":"Api-Token","value":"Options: [P30D | P60D | P90D]
\n","type":"text"}]},"url":"https://api-test.qbssoftware.com/api/v1/renewal/alert-end-user","urlObject":{"protocol":"https","path":["api","v1","renewal","alert-end-user"],"host":["api-test","qbssoftware","com"],"query":[],"variable":[]}},"response":[{"id":"d993b8ca-4362-4576-8493-dbdd726b1680","name":"Place End User Alert","originalRequest":{"method":"POST","header":[{"key":"Api-Token","value":"