{"_id":"5579fc70a7e7ab35006a095b","category":"5548466cd2c8410d006c2147","excerpt":"","parentDoc":null,"__v":36,"githubsync":"","hidden":false,"isReference":false,"link_external":false,"order":0,"project":"5548466bd2c8410d006c2143","version":"5548466bd2c8410d006c2146","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"createdAt":"2015-06-11T21:24:00.522Z","link_url":"","slug":"","sync_unique":"","type":"basic","user":"5578a95127f77c0d00fe62c1","title":"API Overview","updates":[],"body":"Welcome to our Developer Center. \n\nHere you can learn how our API works, access API documentation and get ideas for integration. \n\nThe API can help you power your projects by enabling your ProjectManager.com data to interact and sync with the tools you already use and the apps you want to create. \n\nProjectManager.com allows you to integrate with your project data using a simple yet powerful set of REST API. Our rich APIs expose a comprehensive set of ProjectManager.com features to our partners and customers. These include Project and Task management, Timesheeting, Resources and Files.\n\nUsing the ProjectManager.com REST API you are able to develop various types of applications.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"* **Create Custom Applications**: Create custom applications to gain additional benefits for your organization using your ProjectManager.com data. \\n  \\n* **Integrate with Other Tools**: Integrate with desktop authoring tools to bring task management closer to the team member's desktop. Check out our complete list of [3rd party apps and integrations](https://www.projectmanager.com/integrations) to see if we have already created a solution that suits your needs. You can also check out \\\"What's Zapier\\\" in the menu on this page.  \\n  \\n* **Integrate with Internal Systems**:  Build integrations with your internal data management systems to exchange data that supports workflow.\",\n  \"title\": \"You can:\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What You Can Do With the API\"\n}\n[/block]\nThe ProjectManager.com API allows you to synchronize data from other systems to your project files and data. Some ideas for integrations include:\n\n  * Synchronize resource data, for example from timesheet applications.\n  * Connect workflow management systems to your project data.\n  * Transfer files between programs.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Usage Guidelines\"\n}\n[/block]\nThe ProjectManager.com engineering team monitors all usage of the API to ensure a quality experience for users of our service and tool. \n\n1.\tIntegrations cannot consume the ProjectManager.com API at a rate greater than 1 requests/1 second. \n2.\tAll data passed to ProjectManager.com must be properly encoded and use application/json formatting.\n3.\tIntegrators should use their own public and documented APIs when working with the ProjectManager.com API.\n4.\tWe reserve the right to change or deprecate the APIs over time. We will provide developers with ample notification in those cases.\n\nIf you have any questions, please contact us at [support:::at:::projectmanager.com](mailto:support@projectmanager.com).\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nOur app uses an API key to access the API. Authentication is managed using HTTP authentication (only \"Basic\" is supported right now). Every request must include the Authorization HTTP header. Use your API key as the apikey.\n\nYour API key can be found by logging into your ProjectManager.com account and opening the account page from the main menu. The API information is on the API tab. By default, this tab is restricted to Admin users only. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We advise making all calls to your ProjectManager.com account over SSL.\",\n  \"title\": \"Important\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Security\"\n}\n[/block]\nThe role-based security matrix defined inside ProjectManager.com applies to calls to the API. For example, API calls to add or update tasks will be declined if a user's role was defined with read-only access to the tasks page in ProjectManager.com.\n\nAdditionally, project level security is also applied where necessary (for example, the list of projects retrieved from an API call will be determined by the project security settings for all non-admin users.)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"CORS\"\n}\n[/block]\nProjectManager.com fully supports Cross-Origin Resource Sharing (CORS), and the HTTP headers that relate to CORS, including pre-flight checks.\n\nYou can find out more about CORS [here.](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Help\"\n}\n[/block]\nIf you have any concerns or questions just drop us an email to [support@projectmanager.com](mailto:support@projectmanager.com)","childrenPages":[]}
Welcome to our Developer Center. Here you can learn how our API works, access API documentation and get ideas for integration. The API can help you power your projects by enabling your ProjectManager.com data to interact and sync with the tools you already use and the apps you want to create. ProjectManager.com allows you to integrate with your project data using a simple yet powerful set of REST API. Our rich APIs expose a comprehensive set of ProjectManager.com features to our partners and customers. These include Project and Task management, Timesheeting, Resources and Files. Using the ProjectManager.com REST API you are able to develop various types of applications. [block:callout] { "type": "success", "body": "* **Create Custom Applications**: Create custom applications to gain additional benefits for your organization using your ProjectManager.com data. \n \n* **Integrate with Other Tools**: Integrate with desktop authoring tools to bring task management closer to the team member's desktop. Check out our complete list of [3rd party apps and integrations](https://www.projectmanager.com/integrations) to see if we have already created a solution that suits your needs. You can also check out \"What's Zapier\" in the menu on this page. \n \n* **Integrate with Internal Systems**: Build integrations with your internal data management systems to exchange data that supports workflow.", "title": "You can:" } [/block] [block:api-header] { "type": "basic", "title": "What You Can Do With the API" } [/block] The ProjectManager.com API allows you to synchronize data from other systems to your project files and data. Some ideas for integrations include: * Synchronize resource data, for example from timesheet applications. * Connect workflow management systems to your project data. * Transfer files between programs. [block:api-header] { "type": "basic", "title": "API Usage Guidelines" } [/block] The ProjectManager.com engineering team monitors all usage of the API to ensure a quality experience for users of our service and tool. 1. Integrations cannot consume the ProjectManager.com API at a rate greater than 1 requests/1 second. 2. All data passed to ProjectManager.com must be properly encoded and use application/json formatting. 3. Integrators should use their own public and documented APIs when working with the ProjectManager.com API. 4. We reserve the right to change or deprecate the APIs over time. We will provide developers with ample notification in those cases. If you have any questions, please contact us at [support@projectmanager.com](mailto:support@projectmanager.com). [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Our app uses an API key to access the API. Authentication is managed using HTTP authentication (only "Basic" is supported right now). Every request must include the Authorization HTTP header. Use your API key as the apikey. Your API key can be found by logging into your ProjectManager.com account and opening the account page from the main menu. The API information is on the API tab. By default, this tab is restricted to Admin users only. [block:callout] { "type": "info", "body": "We advise making all calls to your ProjectManager.com account over SSL.", "title": "Important" } [/block] [block:api-header] { "type": "basic", "title": "Security" } [/block] The role-based security matrix defined inside ProjectManager.com applies to calls to the API. For example, API calls to add or update tasks will be declined if a user's role was defined with read-only access to the tasks page in ProjectManager.com. Additionally, project level security is also applied where necessary (for example, the list of projects retrieved from an API call will be determined by the project security settings for all non-admin users.) [block:api-header] { "type": "basic", "title": "CORS" } [/block] ProjectManager.com fully supports Cross-Origin Resource Sharing (CORS), and the HTTP headers that relate to CORS, including pre-flight checks. You can find out more about CORS [here.](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) [block:api-header] { "type": "basic", "title": "Help" } [/block] If you have any concerns or questions just drop us an email to [support@projectmanager.com](mailto:support@projectmanager.com)