在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:hubplanner/API开源软件地址:https://github.com/hubplanner/API开源编程语言:开源软件介绍:API Documentation for Hub Planner === Welcome to the Hub Planner API which provides programmatic access to Hub Planner Resource Management and Timesheets https://hubplanner.com The following Sections are available:
You can use the API to integrate Hub Planner with your own third party applications or generally integrate with your existing back-office setup. Zapier IntegrationWe offer an integration with Zapier. Please Visit Here to get access and start usign Zaps with HUb Planner. API SupportIf you have a question about using the API or have noticed an error or omission in the documentation. Please feel free to open an issue on GitHub with your question and we will attend to it. If you have any direct implementation issues, please contact the tech team at the following address [email protected] and add API as as the Subject. API Updates and ChangesWe will be managing the API via GitHub, so please watch the Hub Planner API repository to receive email notification of updates to the API documentation. API LimitsFor security reasons we have a daily limit of 6000 API calls and burst limits of 50 per 5 seconds on every account. Please be careful to avoid these limits as otherwise you will get an error response from the API. SharingIf you've built something interesting with the Hub Planner API, made a wrapper for a certain code language or integrated with a third party software you would like to share or think will help others, then please let us know at [email protected] API Data FormatsHub Planner API is a RESTful API that uses HTTP requests and returns JSON for all responses. All URLs start with the root URL:
Content-Type and Accept must be defined in the header of all requests.
Please note that all requests to the Hub Planner API must be made over HTTPS. PaginationMost of the above areas can be paginated using url parameters The max If you pass a limit of The example call to make use of pagination looks like this:
Which will paginate endpoint with 20 results per page. Pages start numbering with The endpoints that can be paginated in most areas are Sorting resultsMost of the endpoints can be sorted ascending or descending based on some of the properties. Documentation for each area you have access to lists sortable
fields in the property table. Results can be sorted for To sort the data add
Will sort the project groups in descending order based on their names. You can chain multiple sort arguments to create more advanced sort results. For example:
Will first sort project groups by their group types in descending order, then sort each group type alphabetically by name. Sample response(with unnecessary properties ommited):
It's suggested that you use sort argument along with pagination. User Agent IdentificationRemember to write your application carefully. In case of abuse you may be blocked, disallowing further API access. As an act of courtesy, please provide User-Agent strings denoting your application.
AuthenticationHub Planner API is authenticated with a OAuth 2.0 Bearer Token. You must supply an Authorization header with the token for all requests.
Where xxx is Your generated API key. Do not provide You must enable API access and generate your API key in order to use the Hub Planner API. The API key is available in All Accounts with Administrator privileges and higher. To generate your API key and enable the API login to your Hub Planner account and navigate to
Here you can generate your key for different rights and enable access. There are 2 types of API keys you can generate.
Please note if you decide to disable access to the API. All API access will be revoked for all generated keys. The generated keys should be considered as sensitive as passwords and must not be shared or distributed to untrusted parties. Error Codes & ResponsesOverview of possible HTTP status codes
|
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论