API V8 Documentation

SuiteCRM Forum - English Language SuiteCRM General Discussion
1

We are developing mobile application for our internal use, We are using API v8 but the documentation is not proper so we are facing some issues.
Can anyone help to provide link or document for API V8?

2

The next version (7.10.10) will contain API developments, and there is some new documentation being prepared for it.

You can see a preview here:

https://deploy-preview-151–suitedocs.netlify.com/

But this is a work in progress…

2 Likes
3

After reading the customization page under that address (https://deploy-preview-151–suitedocs.netlify.com/developer/api/version-8/customization/), I tried to write some custom routes. No dice, but by analyzing the core API I found I could mirror the [suite_root]/lib/API tree in [suite_root]/custom/lib/API, similar to how the rest of Suite works. So to add custom routes, for instance, I create the statements in [suite_root]/custom/lib/API/v8/route/some_routes_file.php and it works.

Now that I understand how to do this, the question I have is whether this will persist in future versions of Suite. It makes sense to use the custom/ subtree this way, as it’s been a convention for a long time in Sugar, and much of Suite still works the same way. But the documentation describes a very different process, and it doesn’t appear to reflect the behavior of the version of SuiteCRM I’m running in my development environment now (7.10.7).

4

Right now the thing to do is… wait a week or two. When the next minor release happens, new API code will be there; then the developer will be freed up to (briefly) update the Docs. Then once people start having success we can expect others from the Community to help in improving the Docs.

Thanks for your comments and your patience.

5

We are ready to update documentation once we get basic things and understanding.

1 Like
6

Is any proper documentation link for API 8?

7

The link is this

https://docs.suitecrm.com/developer/api/version-8/

There have been updates since 8 months ago, when we last spoke about this here. But I know that the API is still being developed, the work on Suite8 also affects this. And the Docs are in need of updating, they’re not very accurate at the moment, I am afraid… :frowning: