[Question] Rest API, how to setup and use?

[Sasamous]

Description

Hello, I can't find anywhere a documentation that say how to setup and use API, I'm about to create a connector between this CRM and an existing ERP system, but I don't know where to start from YetiForce.

I found just this partial documentation in other tickets, but isn't enough explicit.

Someone know a place where to find a documentation or can suggest me how to use YetiForce API?

Thank you in advance. 😄

• [x] Understood way
• [x] Got slightly enough documentation
• [x] Got examples
• [x] Activated webservices by php
• [ ] Solved all problems
• [ ] In production! 😃

[rskrzypczak]

https://github.com/YetiForceCompany/YetiForceCRM/issues/11841#issuecomment-547734984

[Sasamous]

#11841 (comment)

Shouldn't it set by default for every module? So I can access everything from API by default, if I need to exclude something I could disable it by that field 🙂 @mariuszkrzaczkowski

Btw today it works without this fix, I dunno why, maybe a new commit fixed it (on demo version).

I will maintain opened my issue until a full API functionality isn't implemented, I'm creating a complete connector between YetiForce and C++ ERP Systems, so I must use all API calls in all ways for that reason.

[gogroup-official]

how to get sum total records by x-condition via api

[mariuszkrzaczkowski]

@ezbank create a new issue

[Sasamous]

I'm asking for a complete API documentation, I like you added this to 5.3 Milestone, but you can't close this until you wrote a full API Documentation.

I see you used Swagger to give some examples of "Record" action, but there are a lot of other actions (Dashboard, Fields, Hierarchy, Pdf, PdfTemplates, Privileges, RecordRelatedList, RecordsList..) so how can users use those actions?

Also, where do you show body headers? Like x-condition, x-fields.. I expect you will close this post when you get a documentation of your API System.

Thanks for your commitment 😃

[bpabiszczak]

but you can't close this until you wrote a full API Documentation.

Of course I can :)

[Sasamous]

but you can't close this until you wrote a full API Documentation.

Of course I can :)

Yes, but it is clear you are randomly closing issues that aren't really closed and adding them to 5.3 Milestone to increase the "Complete" percentage instead of taking care of opened issues :)

[bpabiszczak]

I don't know what makes you think that if you ask for complete documentation the issue will be open until this "demand" of yours is met. The documentation is the way it is, if you don't think it's complete you can always expand it.

If you don't want to pay then accept the current state of the application/documentation.

If you do want to pay then, for a fee, we can expand the documentation, teach you how to use API, solve API issues. The whole community will surely be thankful to you if you spend several thousand € on the API documentation.

[Sasamous]

I'm actually working on your product by creating a connector between your CRM and several ERP Systems;

so your CRM will increase users by a lot once we (me and my team) finish the project.

But if your product is incomplete, because you don't have a documentation on how to use it, and you ask your users (who in this case are actually working for your CRM) to pay several thousand € to ask you to work on your project just by writing a documentation, that should be the first thing to do in a public software, I don't think we are creating a connect between ERP Systems and the right CRM System.

By the way, I'm actually creating a sort of documentation in your GitHub issues section, by creating very detailed issues with tons of information useful for you and for who is reading, so your community is already thankful to me.

So, your request to users to

spend several thousand € on the API documentation.

is pretty ridiculous because it means your software isn't really free if users can't use it without paying it.