Our API documentation has recently been updated to use Swagger and conforms to the OpenAPI 3 Specification. It is maintained in the following repository, where you can submit questions, bugs, or better yet pull requests!
Alternatively you may wish to ask your question(s) on our Developer Forum.
Please note that our API documentation includes an interactive browser, where you can test out your API requests.
It's built in
Angular.js and only supports
Changes (non staff)
If you find a bug in our documentation, or think something could be clearer, we'd love to hear from you. Just open a ticket in this repo, the Swagger repo, or our Developer Forum and one of our developers will get to it when time allows.
Alternatively, if you would like to make the changes yourself, we'd love to accept pull requests. Just fork the repo make your changes and submit a pull request related to the ticket you've opened.
To create a new blog post on the developer forum, create a new file in the
You can use markdown or HTML. The filename must be in this format:
The first bit of a post should be like this:
--- layout: post title: "API Client Ruby Gem" slug: "api-client-gem" category: blog author: peter date: 2015-07-21 13:24:22 excerpt: "Short text about post. Used as summary in blog list & meta tags for social sharing / SEO" graphic: /img/feature-graphic.png (used in meta tags for social sharing) ---
You can also add an optional
extract: if you want to customize the extract shown on the
/blog page. If you don't specify this it will use the first paragraph.
To make any updates to the API documentation, you will need to make changes to the
swagger.yaml file in the Swagger repository.
If you've made local changes to the repository, you can start the server with the command:
When you're finished with the changes, make a pull request.
As soon as the pull request is merged into
master, it will be automatically deployed by GitHub pages.
- API documentation: https://developer.onepagecrm.com/api
- Developer forum: http://forum.developer.onepagecrm.com
- Swagger repo: https://github.com/OnePageCRM/swagger