× Freshbooks应用标识
FreshBooks
官方应用程序
免费-谷歌播放
得到它

FreshBooks API文档

快速启动

右边的列有一个curl调用,演示了所需的标题和对FreshBooks API的请求的一般格式。

请求使用OAuth2承载令牌进行身份验证,在登录用户执行授权授予请求后,您将收到我们发出的代码作为交换。您可以创建一个OAuth应用程序,并在您的FreshBooks中获取客户端id和secret开发人员页面

介绍

FreshBooks API是一个使用JSON访问FreshBooks数据的接口。该API使创建web和桌面应用程序与您的帐户集成很容易。它的可能用途包括当用户在你的网站注册时自动创建和发送发票,拉出客户信息列表,复制数据到第三方服务,等等。

请查看我们的场景和API参考部分,看看会发生什么,如果您准备好了,请注册一个FreshBooks帐户(如果您还没有),然后继续开发人员页面创建应用程序并开始开发。

要求标题

大多数调用都需要两个头文件:

  1. 内容类型:application / json
  2. 授权:持票人

我们需要他们俩理解并验证你的电话。该页面上的黑色代码窗格显示了正确发送这些标头的调用示例。

在FreshBooks上创建应用程序

如果您已经有一个FreshBooks帐户,请访问我们的登录页面或访问我们的网站创建帐户注册页面。您可以联系我们的支持团队,让您的帐户加入我们的合作伙伴计划。

  1. 现在访问开发人员页面并创建一个新应用程序
  2. 确保在应用程序表单中包含应用程序的名称并重定向URI。
    应用程序的名称必须是唯一的,因为它将用于显示在FreshBooks应用程序商店和FreshBooks用户的集成一旦他们连接到您的应用程序。重定向URI应该是应用程序中的一个端点,它将接收授权代码,并使用它来检索承载令牌和刷新令牌。这些是对FreshBooks API进行身份验证调用所必需的。要获得更多的信息,我们的认证过程访问我们的Oauth文档
  3. 保存您的应用程序。

在开始之前

以下是我们在考虑任何a +的集成时需要考虑的一些事项的快速清单:

  1. 在你的网站上创建一个专门的集成页面
  2. 创建一个专用的链接/页面,可以在我们的集成页面中链接到,这允许简单的应用程序启用
  3. 可以用于集成的应用程序徽标,包括应用程序内部和集成页面
  4. 在你的网站上创建一个链接到FreshBooks。这个链接应该包括新书的描述
  5. 向FreshBooks提供您的支持时间和政策的描述
  6. 该应用程序应该能够轻松地自助安装——这意味着FreshBooks用户应该能够在不需要发送电子邮件或与他人交谈的情况下启动集成
  7. FreshBooks有不同的帐户级别,其中包括针对特定用户的有限数量的客户端。因此,当您构建集成时,您应该考虑构建支持所有FreshBooks客户的集成,或者您应该明确地告知您的集成是为哪些客户构建的

加入FreshBooks开发者社区!

请加入我们的网站,以获取最新的FreshBooks API邮件列表

如果您想在我们的App Store上列出您的应用程序,请填写申请表

在Twitter上关注我们@freshbooksdevs

发送发票

-H "Content-Type: application/json" -d ' {"invoice": {"email_subject": "Some Subject", "email_body": "sample email body", "action_email": true}} ' "https://api.freshbooks.com/accounting/account//invoice /发票/发票/"

上传一张图片到FreshBooks

-H " content - type: application/json"——form 'content=' "https://api.freshbooks.com/uploads/images"

在Freshbooks上创建一个新应用程序

curl - x POST - h - h“授权:无记名<无记名>”“application / json - type:“- d”{“名称”:“< app_name >”,“redirect_uri”:“< >应用程序重定向uri”、“描述”:“<应用descripttion >”,“website_url”:“<链接到应用程序网站>”,“settings_url”:“< >链接到应用程序设置”,“logo_public_id”:“< jwt后回来https://api.freshbooks.com/uploads/images > "} " " https://api.freshbooks.com/auth/api/v1/partners/applications "

得到所有应用

-H "Content-Type: application/json" "https://api.freshbooks.com/auth/api/v1/partners/applications"

修改现有的应用程序

curl - x - h”授权:无记名<无记名> " - h”application / json - type:“- d”{“名称”:“< app_name >”,“redirect_uri”:“< >应用程序重定向uri”、“描述”:“<应用descripttion >”,“website_url”:“<链接到应用程序网站>”,“settings_url”:“< >链接到应用程序设置”,“logo_public_id”:“https://api.freshbooks.com/uploads/images > < jwt后回来”}”“https://api.freshbooks.com/auth/api/v1/partners/applications/ < app_client_id >”

发送发票142571

url = " https://api.freshbooks.com/accounting/account/ < accountid > /发票/发票/ < invoiceid >”标题={“授权”:“不记名<Bearer Token>”,“内容类型”:“application / json”}载荷={"发票":{“email_subject”:“一些主题”,“email_body”:“样本邮件的身体”,“action_email”:真正}}res =请求。put (url, data = json.dumps(载荷),标题=标题)