Menu
SuiteCRM Pull Request Party hosted by SalesAgility
Welcome, Guest
Username: Password: Remember me

TOPIC: Any documentation on SuiteCRM 7.10 Beata Brand new Rest API?

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 5 months ago #56928

  • shijin_k
  • shijin_k's Avatar
  • Offline
  • New Member
  • Posts: 12
  • Thank you received: 1
  • Karma: 1
I have downloaded and installed SuiteCRM 7.10 Beta 2. I would like to do some exploration on the Brand New fully compliant Rest API. Do we have any document available currently? Or could you please suggest some direction so that I can figure out something from the file system?

Thanks in advance!
Shijin Krishna
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 5 months ago #56937

  • vladimirp
  • vladimirp's Avatar
  • Offline
  • Junior Member
  • Posts: 21
  • Thank you received: 1
  • Karma: 1
I just downloaded the SuiteCRM 7.10. Beta 2 and have the same questions as shijin_k.

I don't see anything new in /service/ folder, where is new API and how to use it?
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 5 months ago #56938

  • shijin_k
  • shijin_k's Avatar
  • Offline
  • New Member
  • Posts: 12
  • Thank you received: 1
  • Karma: 1
I could find some files under lib/SuiteCRM/API. But still no idea how to use it.
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 5 months ago #56939

  • pgr
  • pgr's Avatar
  • Offline
  • Administrator
  • Posts: 9910
  • Thank you received: 1475
  • Karma: 350
There is no documentation on it yet, it's all still very new... being written right now.

My SuiteCRM In-depth blog.
Thank you for always stating your SuiteCRM version, checking your logs, reading the Docs, and searching before you ask!
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 5 months ago #57162

  • vladimirp
  • vladimirp's Avatar
  • Offline
  • Junior Member
  • Posts: 21
  • Thank you received: 1
  • Karma: 1
Ok waiting for the documentation, it can be quite sketchy - beats reverse engineering anyhow
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 4 months ago #57410

  • vladimirp
  • vladimirp's Avatar
  • Offline
  • Junior Member
  • Posts: 21
  • Thank you received: 1
  • Karma: 1
Since no documentation is available yet I found swagger file located in \lib\API\v8\swagger.json.

I am going to analyze it and report back on findings.
The administrator has disabled public write access.
The following user(s) said Thank You: pgr

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 2 months ago #60536

  • shijin_k
  • shijin_k's Avatar
  • Offline
  • New Member
  • Posts: 12
  • Thank you received: 1
  • Karma: 1
Hello,

The release note says:

A new Rest API (v8) using the popular JSONAPI specifications. The v8 API mirrors the prior API functionality so there will be no loss of functionality. It also introduces authentication using OAuth 2.0 and bringing the SuiteCRM API up to industry standards.
Swagger documentation
The v8 API adopts the Swagger (OpenAPI v3.0) framework to provide detailed, but clear, documentation.
To access the swagger json file use the path https://<instance>/api/v8/swagger.json

But in SuiteCRM 7.10 stable version, there is no SuiteCRM directory under /lib and hence the url redirection given in .htaccess fails.

I also tried to execute the v8 APIs using SwaggerUI. Below are the problems I faced.

1) When I click on Authorize nothing happens except the js error in the console.

www.screencast.com/t/SwfSY4oPmzc6

2) And the APIs doesn't allow to edit any parameters.

www.screencast.com/t/2TPBnG8Y

Thanks!
Shijin Krishna
Last Edit: 1 year 2 months ago by shijin_k.
The administrator has disabled public write access.

Any documentation on SuiteCRM 7.10 Beata Brand new Rest API? 1 year 2 months ago #60538

  • pgr
  • pgr's Avatar
  • Offline
  • Administrator
  • Posts: 9910
  • Thank you received: 1475
  • Karma: 350
Here's your full documentation for SuiteCRM REST API v8

docs.suitecrm.com/developer/api/api-8/

My SuiteCRM In-depth blog.
Thank you for always stating your SuiteCRM version, checking your logs, reading the Docs, and searching before you ask!
The administrator has disabled public write access.
The following user(s) said Thank You: shijin_k
Time to create page: 0.053 seconds
Powered by Kunena Forum