Code documentation

How to configure and adapt Aimeos based shops as developer
Forum rules
Always add your Aimeos and PHP version as well as your environment (Linux/Mac/Win)
Spam and unrelated posts will be removed immediately!
adityabanerjee
Posts: 44
Joined: 05 Oct 2019, 06:42

Code documentation

Post by adityabanerjee » 22 Nov 2019, 06:11

Hi, I want to learn about the architecture of the Aimeos. Is there documentation that would explain the APIs? My goal is to create my own API for Aimeos. So for that, the documentation would be helpful.

User avatar
aimeos
Administrator
Posts: 7836
Joined: 01 Jan 1970, 00:00

Re: Code documentation

Post by aimeos » 23 Nov 2019, 08:26

A general overview is available here:
https://aimeos.org/docs/Developers/Software_stack

What kind of API do you want to extend? The JSON REST API?
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

adityabanerjee
Posts: 44
Joined: 05 Oct 2019, 06:42

Re: Code documentation

Post by adityabanerjee » 23 Nov 2019, 08:39

Yes JSON REST API.

User avatar
aimeos
Administrator
Posts: 7836
Joined: 01 Jan 1970, 00:00

Re: Code documentation

Post by aimeos » 25 Nov 2019, 10:01

The JSON REST API is explained here:
https://aimeos.org/docs/Developers/Client/JSONAPI

To add your own endpoints, please have a look into the code:
https://github.com/aimeos/ai-client-jso ... nt/jsonapi

You should use an existing endpoint class that is close to what you want to implement and copy/paste/adapt it to your needs.
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

Post Reply